IDimSelection.ToString

Синтаксис

ToString(

[Format: String = "";]

[Separator: String = ",";]

[CollectRanges: Boolean = False]): String;

Параметры

Format. Необязательный параметр, определяющий идентификатор атрибута справочника, по значениям которого будет сформирована отметка. По умолчанию значение отметки формируется из значений атрибута - Наименование.

Separator. Необязательный параметр, определяющий разделитель, используемый для отделения элементов друг от друга. По умолчанию используется - «,».

CollectRanges. Необязательный параметр, определяющий будут ли числовые значения атрибутов группироваться в диапазоны, разделенные знаком «-». По умолчанию группировка не производится.

Описание

Метод ToString формирует значение отметки в строковом виде в соответствии с установленными параметрами.

Комментарии

Для добавления всех элементов справочника в отметку используйте метод IDimSelection.SelectAll.

Пример

Для выполнения примера в репозитории предполагается наличие справочника НСИ с ключом 6443, содержащего атрибуты с идентификаторами KEY и NAME.

Добавьте ссылки на системные сборки: Dimensions, Metabase.

Sub UserProc;
Var
    MB: IMetabase;
    Dimen: IDimInstance;
    Selection: IDimSelection;
Begin
    MB := MetabaseClass.Active;
    Dimen := MB.Item(6443).Open(NullAs IDimInstance;
    Selection := Dimen.CreateSelection;
    // добавим все элементы в отметку:
    Selection.SelectAll;
    // Названия элементов:
    Debug.WriteLine(Selection.ToString(Format := "NAME", Separator := ", ", CollectRanges := True));
    // Ключи элементов:
    Debug.WriteLine(Selection.ToString(Format := "KEY", Separator := " | ", CollectRanges := False));
End Sub UserProc;

При выполнении примера в окно консоли будут выведены строковые представления отметки, сформированные по разным атрибутам и с разными настройками.

См. также:

IDimSelection