DB.GetCaption

GetCaption (Работа с перечислениями)
Объект: Объект базы данных Статус разработки: Реализована Тип: Функция Обращение к БД: Нет Исключения: Неверное наименование, невозможно превратить в строку Визуальность: Нет

• Начальная страница
• Общее описание
• Объекты
• Объект базы данных

Получить описание значения перечисления по выбранному объекту перечисления или по наименованию перечисления и наименованию его значения. Описание в отличие от наименования, это строка, которая используется, при выводе выбранного перечисления на экран. Функция может быть использована совместно с интерфейсом перечисления (Enum, к примеру, Enum.GetCaption("ТипКонтрагента.Поставщик")).

Синтаксис

DB.Enum.GetCaption({<Выбранный объект перечисления (DB)>,<Наименование перечисления.Наименование значения перечисления (STRING)>}):<Описание значения перечисления (STRING)>

Аргументы

• <Выбранный объект перечисления (STRING)> или <Наименование перечисления.Наименование значения перечисления (STRING)> - Если аргумент представляет собой выбранное перечисление, функция возвращает описание его выбранного значения, иначе используется строка для нахождения перечисления и его значения по наименованию и возвращается описание выбранного значения.

Возвращаемое значение

Возвращается описание значения перечисления.

Примеры

//Фрагмент создает выбранное перечисление вида ТипыКонтрагентов со значением Поставщик и выводит описание значения этого перечисления
aEl:=Enum.Get("ТипКонтрагента.Поставщик");
Message(Enum.GetCaption(aEl));
//Та же самая операция, но без предварительного создания объекта
Message(Enum.GetCaption("ТипКонтрагента.Поставщик"));