IDimSelection.ToString

Синтаксис Fore

ToString(

[Format: String = "";]

[Separator: String = ",";]

[CollectRanges: Boolean = False]): String;

Синтаксис Fore.NET

ToString(

Format: string;

Separator: string;

CollectRanges: boolean): string;

Параметры

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

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

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

Описание

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

Комментарии

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

Пример Fore

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

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

Sub UserProc;
Var
    MB: IMetabase;
    Dimen: IDimInstance;
    Selection: IDimSelection;
Begin
    MB := MetabaseClass.Active;
    Dimen := MB.Item(6443).Open(Null) As 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;

После выполнения примера в окно консоли будут выведены наименования и ключи элементов.

Пример Fore.NET

Необходимые требования и результат выполнения примера Fore.NET совпадают с примером Fore.

Imports Prognoz.Platform.Interop.Dimensions;
…
Public Shared Sub Main(Params: StartParams);
Var
    MB: IMetabase;
    Dimen: IDimInstance;
    Selection: IDimSelection;
Begin
    MB := Params.Metabase;
    Dimen := MB.Item[6443].Open(Null) As IDimInstance;
    Selection := Dimen.CreateSelection();
    // добавим все элементы в отметку:
    Selection.SelectAll();
    // Названия элементов:
    System.Diagnostics.Debug.WriteLine(Selection.ToString("NAME", ", ", True));
    // Ключи элементов:
    System.Diagnostics.Debug.WriteLine(Selection.ToString("KEY", " | ", False));
End Sub;

См. также:

IDimSelection