Struct.CaptionTemplate

From SunFlurry wiki
Jump to: navigation, search
  CaptionTemplate (Шаблон представления)
Объект:Объект структуры базы данных
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Исключения:Неверное позиционирование
Визуальность:Нет

Функция применяется к объекту структуры базы данных, позиционированному на объекте базы данных, определенного вида, и возвращает правило формирования (шаблон) его представления. В отличие от функции Caption, являющейся представлением типа данных, т.е., применимой к метаданным, этот шаблон используется для создания наименований объектов базы данных, т.е., реальных объектов, выводящихся на экран в логах, таблицах и пр. См. Конфигурация данных проекта (CaptionTemplate). Данная функция возвращает шаблон в том виде, в каком он был задан в Студии. По умолчанию, для новых справочников добавляются реквизиты "Name" и "Code", и шаблон представления объектов устанавливается, как %Name%; для новых документов по умолчанию добавляются реквизиты "DocNum" и "DocDate", и шаблон представления объектов устанавливается, как <Имя вида документа> №%DocNum% от %DocName%. Шаблоны по умолчанию можно изменить в Студии.

Синтаксис

Struct.CaptionTemplate():<Правило формирования представления объекта (STRING)>

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

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

Примеры

//Фрагмент выводит список наименований и шаблоны формирования представлений справочников проекта.
For i:=1 To Struct.Ref.Count() Do
  Message(Struct.Ref(i).Name+": "+Struct.Ref(i).CaptionTemplate);
EndDo;