Это старая версия документа.
Редактирование метаданных
В информационном окне отражаются сведения о загрузке и применении метаданных.
Список модулей
Вверху окна расположен раскрывающийся список модулей и кнопка, вызывающая меню (Рис. 2). Раскрывающийся список содержит список модулей, включенных в метаданные.
По кнопке 
можно настроить отображающиеся в дереве классы: отображать классы только текущего модуля, показывать удаленные.
Отображать классы тек. модуля - Если опция меню отмечена, то при выборе модуля из раскрывающегося списка модулей, в дереве классов будут отображены только классы, принадлежащие выбранному модулю. Если опция не выбрана, то в дереве классов будут показаны все классы, независимо от их модульной принадлежности, но классы, не относящиеся к текущему модулю, будут неактивны, то есть будут выделены в дереве серым цветом. Если у класса, не принадлежащего текущему модулю, есть классы-наследники, принадлежащие текущему модулю, то класс-родитель выделяется в дереве классов синим цветом.
Показывать удаленные - При выборе этой опции меню в дереве классов будут отображены все классы, включая удаленные ранее классы. Удаленные классы выделяются в дереве красным цветом.
Дерево классов
Классы, принадлежащие текущему модулю (модулю, выбранному из раскрывающегося списка), отображаются в дереве стандартным черным цветом. Классы, не принадлежащие текущему модулю, отображаются серым цветом. Однако, если у класса, не принадлежащего текущему модулю, хотя бы один потомок принадлежит текущему модулю, то класс-родитель отображается в дереве классов синим цветом. Такая подсветка классов позволяет легко ориентироваться в большой и многоуровневой иерархии классов. Для удобства чтения информации о классе, у каждого класса есть пиктограммы. Их значения описаны в Таблица 1 Пиктограммы классов. Все действия с классами производятся из контекстного меню дерева классов, описание пунктов контекстного меню приведено в Таблица 2 Контекстное меню дерева классов.
| Пиктограмма | Значение |
|---|---|
 | Класс - потомок класса "Классы". |
 | Перечисление - потомок типа "Перечисления". |
 | Класс - потомок класса "Элементы списков". |
 | Наличие этого элемента в пиктограмме обозначает, что класс допускает хранимые ссылки. |
 | Наличие этого элемента в пиктограмме обозначает, что класс нехранимый. |
 | Наличие этого элемента в пиктограмме обозначает, что класс доступен только для просмотра. |
 | Наличие этого элемента в пиктограмме обозначает, что класс пользовательский - есть возможность редактирования. |
| Пункт меню | Описание |
|---|---|
| Добавить | Добавляет класс на том же уровне, где находится текущий класс. Другими словами, новый класс будет иметь тот же класс-родитель, что и текущий класс, и принадлежать текущему модулю, который выбран в списке модулей. |
| Добавить от текущего | Добавляет класс уровнем ниже текущего класса. То есть текущий класс будет являться классом-родителем для нового класса, и новый класс будет принадлежать текущему модулю, который выбран в списке модулей. |
| Редактировать | Вызывает форму "Свойства класса" для редактирования названия класса, набора системных и дополнительных опций. Редактировать можно только пользовательские классы. |
| Просмотреть | Вызывает форму "Свойства класса" для просмотра. |
| Удалить | Удаляет текущий класс, оставляя возможность восстановления командой "Восстановить" контекстного меню строки класса. |
| Удалить полностью | Удаляет текущий класс полностью, без возможности восстановления. |
| Восстановить | Восстанавливает ранее удаленный класс. |
| Найти | Выводит форму поиска для поиска класса в дереве по имени класса. При успешном поиске найденный класс становится текущим. |
| Найти далее | Продолжает поиск класса в дереве, по заданному ранее имени. |
Свойства класса
Форма "Свойства класса" (Рис. 3) вызывается при добавлении нового класса, редактировании или просмотре существующего. Создание и редактирование возможно только для пользовательских классов, к их названию добавляется префикс usr_. Вызов класса на редактирование осуществляется выбором пункта контекстного меню.
Внимание!
Все пользовательские справочники рекомендуется создавать в классе База.Справочники.
Внимание!
Имя пользовательского класса должно состоять из букв, цифр и знаков подчеркивания. Начинаться такие имена могут с буквы или со знака подчеркивания.
Вкладка "Опции" недоступна для изменений. Пользовательские классы и пользовательские элементы списков всегда хранимые.
На вкладке "Доп. опции" определяется набор дополнительных опций класса. Из контекстного меню можно вносить доп. опции по категориям. Удаление опции производится из контекстного меню выбором пункта "Удалить строку". Описание дополнительных опций класса приведено в Таблица 3 Дополнительные опции класса.
На вкладке "Ключи" задаются ключи для класса - как простые (уникальность проверяется по одному параметру), так и составные (уникальность проверяется по сочетанию нескольких параметров). Удаление ключа производится из контекстного меню по пункту "Удалить строку".
На вкладке "Значения" устанавливаются значения параметров по умолчанию во вновь создаваемом объекте класса.
Внимание!
Для класса обязательно задание значений по умолчанию для параметров guid и Название. Значения могут быть заданы автоматически на основе текущего названия класса с помощью нажатия на кнопку "Задать умолчания" в окне добавления/редактирования класса.
На вкладке "Описание" дается многострочное описание функционального назначения класса и его места в объектной иерархии.
| Название | Тип | Назначение |
|---|---|---|
| Категория "ПоказКласса" | ||
| ПоказКласса.Заголовок | Строка | Опция класса, содержит Заголовок класса, который будет показываться в стандартных формах в заголовке. Если значение доп. опции не задано или доп. опция отсутствует на вкладке "Описание" - берется ПолноеНаименование класса. |
| ПоказКласса.ТолькоЧтение | Логика | Объект класса нельзя модифицировать, независимо от настроек прав. |
| ПоказКласса.Видимый | Логика | Для показа по умолчанию в формах выбора справочника (Нет - класс будет показан только после включения опции "Показывать все"), а также для показа в Навигаторе объектов (Нет - класс не будет показан в Навигаторе объектов кроме ситуации, когда он выведен на отдельной вкладке). |
| ПоказКласса.Иконка | Целое | Номер иконки класса для показа в формах выбора справочников. Набор иконок недоступен для модификации. Нумерация иконок совпадает с нумерацией соответствующих графических файлов из папки objects, которая находится по следующему пути: <Каталог установки Business Studio>\BS_Portal\www\img\objects\ (например, C:\Program Files\STU-Soft\Business Studio 4.0\BS_Portal\www\img\objects\). |
| ПоказКласса.ГлавныйКлюч | Имя главного ключа, по нему осуществляется автоматический импорт/экспорт и автогенерация объектов импорта. | |
| ПоказКласса.Иерархический | Логика | Используется для импорта, для стандартных форм. Если значение опции Да - разрешается создавать группы в стандартных формах. При импорте объекты создаются группами, если этот момент не указан особо. Нет - Не разрешается создавать группы в стандартных формах. При импорте объекты создаются не группами, если этот момент не указан особо. |
| ПоказКласса.ЗависимыеКлассы | Строка | Значение - перечень зависимых классов, которые хотелось бы открыть из данного класса. Обычно в зависимых классах есть объектный параметр исходного класса. |
| ПоказКласса.ПолныйДоступ | Логика | Да - полный Доступ/Модификация объекта класса есть всегда, независимо от настроек прав, кроме случаев, когда установлены явные запреты на Доступ/Модификацию объекта класса. |
| ПоказКласса.Авторазмер | Логика | Если значение опции Нет - то авторазмер сетки снимается, и размер каждой колонки подбирается автоматически (появляется горизонтальная прокрутка). По умолчанию - Да (если значение доп. опции не задано или доп. опция отсутствует на вкладке "Описание"). |
| ПоказКласса.Синхронизировать | Логика | Определяет, будет ли на форме включена кнопка синхронизации. В формах списков объектов и форме редактирования объекта синхронизация включена по умолчанию. |
Параметры класса
Параметры выделенного класса отображаются в списке "Параметры". При создании параметров необходимо учитывать принцип наследования, описанный в Термины и понятия. Не нужно создавать в классе параметры, дублирующие параметры класса-родителя.
Параметры также имеют пиктограммы, значения которых приведены в таблице ниже.
| Пиктограмма | Значение |
|---|---|
 | Параметр класса. |
 | Наличие этого элемента в пиктограмме означает, что этот параметр не хранимый, то есть рассчитываемый, пользователь не сможет изменять его в программе. |
| | Наличие этого элемента в пиктограмме означает, что этот параметр только для чтения, то есть системный, редактирование такого параметра в структуре данных невозможно. |
Все действия с параметрами классов производятся из контекстного меню списка параметров.
| Пункт меню | Описание |
|---|---|
| Добавить | Добавляет параметр в текущем классе. |
| Удалить | Удаляет текущий параметр. |
| Редактировать параметр | Вызывает форму "Настройки параметра класса" для редактирования названия параметра, типа, набора дополнительных опций и описания параметра. |
| Просмотреть параметр | Вызывает форму "Настройки параметра класса" только для просмотра настроек текущего параметра. |
| Перейти по ссылке | Пункт меню доступен для не простых параметров (объектный, список, структура, перечисление). При выборе пункта осуществляется переход к классу, указанному в типе параметра. Таким образом, производится быстрая и наглядная навигация по дереву классов. |
Настройки параметра класса
Форма "Настройки параметров класса" (Рис. 4) вызывается при добавлении нового параметра или редактировании существующего. Создание и редактирование возможно только для пользовательских параметров, к их названию добавляется префикс usr_.
Внимание!
Имя пользовательского параметра должно состоять из букв, цифр и знаков подчеркивания. Начинаться такие имена могут с буквы или со знака подчеркивания.
Вызов параметра на редактирование осуществляется либо выбором соответствующей опции всплывающего меню, либо двойным щелчком на параметре левой кнопкой мыши.
На вкладке "Опции" необходимо выбрать тип параметра: простой, объектный, список, структура, перечисление.
Если тип параметра Простой, то необходимо уточнить его тип: логический, целый, строка, вещественный, датавремя, изображение, бинарный или текст. Для параметра типа Строка необходимо указать длину, максимум 4000 символов. Для параметра типа Вещественный необходимо указать длину и точность (количество знаков после запятой), максимум 28 символов. Если тип параметра Объектный, то необходимо указать класс, который будет являться типом объектов, на которые будет ссылаться этот параметр.
Если тип параметра Список или Структура, то необходимо указать элементы списка, которые будут являться типом объектов, на которые будет ссылаться этот параметр.
Если тип параметра Перечисление, то в качестве типа объектов указывается перечисление. Тип параметра выбирается по кнопке 
.
Внимание!
Общая длина (сумма длин всех параметров) класса, заданных на одном уровне в иерархии классов, не должна превышать 8000 Байт. Таблица длин параметров приведена в size_params.
Опции параметра Только для чтения, История и Наследуемый недоступны для изменений, т.к. пользовательские параметры всегда редактируемые, без истории, не наследуемые.
Пользовательский параметр может быть не хранимым, т.е. он может сам не хранить информацию, а использоваться для вывода данных, хранящихся в других параметрах системы.
Например, можно создать для класса Процессы пользовательский параметр для вывода данных из параметра процесса Версия.Автор.
Это делается следующим образом: для класса Процессы создается параметр, аналогичный тому, что заведен у Версии, т.е. на вкладке "Опции" формы настройки параметра задается Тип параметра - значение Простой, Тип свойства - значение Строка [100], устанавливается галочка для опции "Не хранимый". Далее открывается вкладка "Доп. опции" и вводится опция Показ.Префикс со значением Версия.Автор.
На вкладке "Доп. опции" определяется набор дополнительных опций параметра класса. Они позволяют указывать заголовки, управлять порядком и видимостью по умолчанию, настраивать действия. Из контекстного меню можно вносить доп. опции по категориям. Удаление опции производится из контекстного меню выбором пункта "Удалить выделенные строки". Описание дополнительных опций параметра приведено в Таблица 6 Дополнительные опции параметров классов.
На вкладке "Описание" можно дать многострочное описание функционального назначения параметра класса и его места в объектной иерархии.
| Название | Тип | Назначение |
|---|---|---|
| Категория "Показ" | ||
| Показ.Заголовок | Строка | Содержит Заголовок параметра, который будет показываться в стандартных формах. Если значение не задано, берется Наименование параметра. |
| Показ.Видимый | Логика | Если значение опции Да - то параметр показывается в форме списка. Если значение доп. опции не заполнено или доп. опция отсутствует на вкладке "Описание" - Да. |
| Показ.ВидимыйОб | Логика | Если значение опции Да - то параметр показывается в форме единичного показа. Если значение доп. опции не заполнено или доп. опция отсутствует на вкладке "Описание" - используется значение опции "Видимый". |
| Показ.НаВкладке | Логика | Указывается для параметров-списков. Если значение опции Да, то список отображается на вкладке в форме единичного показа. Если опция не заполнена - Нет. |
| Показ.Редактирование | Логика | Если значение опции Да - то параметр редактируется в форме списка. Если значение доп. опции не заполнено или доп. опция отсутствует на вкладке "Описание" - Нет. |
| Показ.РедактированиеОб | Логика | Если значение опции Да - то параметр редактируется в форме единичного показа. Если значение доп. опции не заполнено или доп. опция отсутствует на вкладке "Описание" - Нет. |
| Показ.Обязательный | Логика | Да/Нет. Служит для выделения параметров, обязательных для ввода. |
| Показ.Номер | Целое | Показывает порядковый номер расположения параметра на форме списка объектов. Внимание! В системе есть возможность добавлять/убирать колонки, используя специальную форму. Если вы хотите, чтобы параметр не показывался по умолчанию, но пользователь в дальнейшем может захотеть его показать, нужно проставить Показ.Номер = -1. Тем самым параметр появится в форме кустомизации колонок и можно его перетащить на основную форму. Также если используется опция Показ.Превью то нужно чтобы поле присутствовало в сетке, т.е. нужно ставить Показ.Номер = -1. Следует отметить, что в отличие от формы настройки колонок скрытые колонки загружаются, что снижает быстродействие. |
| Показ.НомерОб | Целое | Задает порядковый номер расположения параметра на форме единичного показа объекта. Для параметров-списков - порядковый номер вкладки. Внимание! Если значение доп. опции не заполнено или доп. опция отсутствует на вкладке "Описание", то порядковый номер заполнится от Показ.Номер. |
| Показ.МинРазмер | Целое | Минимальный размер колонки, по умолчанию 0. Необходимо, например, при авторазмере, когда нужно, чтобы название обязательно было полностью видимым. |
| Показ.Размер | Целое | Задает размер колонки в сетке в форме списка объектов. |
| Показ.Сортировка | Строка | Возможные значения: Возрастание, Убывание. Используется для сортировки по параметру в форме списка. |
| Показ.Формат | Строка | Значение - формат вывода значения параметра в формате C# (см. Руководство пользователя, глава Нумераторы классов). Выводит значение параметра в заданном формате в форме списка. |
| Показ.ФорматОб | Строка | Значение - формат вывода значения параметра в формате C#. Выводит значение параметра в заданном формате в форме редактирования объекта. |
| Показ.Превью | Логика | Параметр, у которого стоит значение Да, появится в виде поля превью под строкой (если заполнен), например, комментарий. Внимание! Чтобы этот параметр показывался, нужно поставить Показ.Номер = -1. Также, если хотите, чтобы это поле показывалось в форме показа объекта - проставьте Показ.НомерОб = 100 (например). Следовательно, данную опцию нужно заполнять, когда порядок в единичной форме показа отличается от формы списка, например Комментарий, который не показывается в форме списка (Показ.Номер=-1), но показывается в форме единичного показа Показ.НомерОб = 100. |
| Показ.Префикс | Строка | Указывается для не хранимых параметров. Значение - ссылка на параметр объекта. Предназначен для вывода вложенных параметров, например Версия.Автор. Пример создания такого параметра см. в начале текущего раздела Настройки параметра класса. Внимание! Тип параметра, для которого задается данная доп. опция, обязательно должен совпадать с типом параметра, на который идет ссылка. |
| Категория "Редактирование" | ||
| Редактирование.Эдитор | Строка | Задает эдитор на экранных формах списков, отличный от стандартного (по умолчанию) для формы списка объектов. Например, для параметра типа Текст эдитор может быть MemoEdit (с просмотром содержимого) или RichEdit (текст в формате RTF), по умолчанию привязан эдитор MemoEditEx - без просмотра содержимого в сетке. Примечание: Эдитор MemoEdit может быть привязан и к параметру типа строка, если нужно автоматически увеличивать высоту ячейки, если строка не помещается. Пользоваться этой возможностью нужно осторожно - нельзя позволять редактировать строку этим эдитором (только просмотр) - так как пользователь может вставить перевод строки. Возможные значения: - MemoEdit, RichEdit (вместо MemoEditEx по умолчанию); - PictureEdit (вместо ImageEdit по умолчанию); - ProgressBar (вместо SpinEdit); - ButtonEdit (для привязки эдитора для выбора, при нажатии на кнопку которого должен выполниться метод, описанный в опции ДействиеПоКнопке). |
| Редактирование.ЭдиторОб | Строка | Задает эдитор на экранных формах объекта, отличный от стандартного (по умолчанию) для формы редактирования объекта. |
| Редактирование.Действие-ПоКнопке | Строка | В качестве значения используется имя метода, который будет запускаться на исполнение при нажатии кнопки "…" эдитора (переопределенного в опции Эдитор, либо ЭдиторОб в значение ButtonEdit). |
| Редактирование.Действие-ПоКнопкеУдалить | Строка | В качестве значения используется имя метода, который будет запускаться на исполнение при нажатии кнопки с крестом эдитора (переопределенного в опции Эдитор, либо ЭдиторОб в значение ButtonEdit). |
| Категория "Связи" | ||
| Связи.Синхронизировать | Логика | Если значение опции Да, то по этому объектному полю будет синхронизироваться форма редактирования объекта данного класса. Если значение Нет - синхронизация не используется. |
| Прочее | ||
| Название доп. опции | Тип доп. опции | Значение опции: =<Название доп. опции данного или одного из вышележащих классов>. В случае использования данного механизма доп. опции параметра класса присваивается значение указанной произвольной опции (переменной) данного или одного из вышележащих классов. Если опция определена в одном из вышележащих классов и в одном из классов-потомков ее значение переопределено - доп. опции будет присвоено переопределенное значение. Механизм может применяться, например, для управления видимостью параметров в классах-потомках (в одних потомках параметр виден, в других - нет). |
Свойства перечисления
Форма "Свойства перечисления" (Рис. 5) вызывается при добавлении нового перечисления или редактировании существующего. Создание и редактирование возможно только для пользовательских перечислений, к их названию добавляется префикс usr_. Вызов перечисления на редактирование осуществляется выбором соответствующей опции контекстного меню.
На вкладке "Элементы" задается список элементов перечисления. Параметры перечисления: значение, наименование, описание. Значение - подставляемое значение, название - системное название элемента, описание - подставляемое название элемента. Удаление элемента перечисления осуществляется из контекстного меню.
Параметр Множество позволяет задавать параметру объекта несколько значений из перечисления. При изменении параметра Множество во включенное состояние для уже созданных объектов, информация в базе не теряется. При отключении параметра Множество информация в базе по параметрам объектов этого перечисления утратится.
Внимание!
Для независимых элементов перечисления-множества, необходимо значениям элементов присваивать степени двойки: 1,2,4,8,…
На вкладке "Описание" дается многострочное описание перечисления.
