# Form.xml ## Краткий шаблон Form ```xml ``` ## Полный шаблон Form ```xml ``` ## Описание Form Тэг ` ``` ## Атрибуты Form ### Name Системное имя формы. Обязательный атрибут. Любое значение будет переведено в текстовое. ### Title Заголовок формы. Необязательный атрибут. Любое значение будет переведено в текстовое. ### Top Координата расположения формы по высоте (сверху вниз). Необязательный атрибут. Ожидается целочисленное значение. Если атрибут `Top` отсутствует и если косвенно атрибуты [`StartPosition`](#start_position), [`HorizontalAlign`](#horizontal_align) и [`VerticalAlign`](#vertical_align) (в порядке значимости) тоже не определяет его значение, то используется стандартное значение .NET. ### Left Координата расположения формы по ширине (слева направо). Необязательный атрибут. Ожидается целочисленное значение. Если атрибут `Left` отсутствует и если косвенно атрибуты [`StartPosition`](#start_position), [`HorizontalAlign`](#horizontal_align) и [`VerticalAlign`](#vertical_align) (в порядке значимости) тоже не определяет его значение, то используется стандартное значение .NET. ### Height Высота рабочей области формы (то есть кайма формы сюда не входит). Необязательный атрибут. Ожидается целочисленное значение. При задании одновременно двух атрибутов `Height` и [`TotalHeight`](#total_height) приоритет имеет `TotalHeight`. Если атрибут `Height` отсутствует, то используется стандартное значение .NET. ### Width Ширина рабочей области формы (то есть кайма формы сюда не входит). Необязательный атрибут. Ожидается целочисленное значение. При задании одновременно двух атрибутов `Width` и [`TotalWidth`](#total_width) приоритет имеет `TotalWidth`. Если атрибут `Width` отсутствует, то используется стандартное значение .NET. ### TotalHeight Полная высота формы (с учетом каймы). Необязательный атрибут. Ожидается целочисленное значение. При задании одновременно двух атрибутов [`Height`](#height) и `TotalHeight` приоритет имеет `TotalHeight`. Если атрибут `TotalHeight` отсутствует, то используется стандартное значение .NET. ### TotalWidth Полная ширина формы (с учетом каймы). Необязательный атрибут. Ожидается целочисленное значение. При задании одновременно двух атрибутов [`Width`](#width) и `TotalWidth` приоритет имеет `TotalWidth`. Если атрибут `TotalWidth` отсутствует, то используется стандартное значение .NET. ### HorizontalAlign Тип положения формы по горизонтали. Необязательный атрибут. Ожидается название одного из типов положения формы по горизонтали:


Left	Левой границей формы к краю левой части экрана
Center	По центру
Right	Правой границей формы к краю правой части экрана

Если атрибут `HorizontalAlign` отсутствует, то значение определяется через атрибуты [`StartPosition`](#start_position) и [`Left`](#left) (в порядке значимости). ### VerticalAlign Тип положения формы по вертикали. Необязательный атрибут. Ожидается название одного из типов положения формы по вертикали:


Top	Верхней границей формы к краю верхней части экрана
Center	Посередине
Bottom	Нижней границей формы к краю нижней части экрана

Если атрибут `VerticalAlign` отсутствует, то значение определяется через атрибуты [`StartPosition`](#start_position) и [`Top`](#top) (в порядке значимости). ### StartPosition Тип положения формы на экране. Необязательный атрибут. Ожидается название одного из типов положения формы на экране:


Manual	Положение формы определяется атрибутами `HorizontalAlign`, `VerticalAlign`, `Top` и `Left` (в порядке значимости)
CenterScreen	Форма с заданными размерами располагается в центре текущего отображения
WindowsDefaultLocation	Форма с заданными размерами размещается в расположении, определенном по умолчанию в операционной системе
WindowsDefaultBounds	Положение формы и ее границы определены в операционной системе по умолчанию
CenterParent	Форма располагается в центре родительской формы

Если атрибут `StartPosition` отсутствует, то значение определяется через атрибуты [`HorizontalAlign`](#horizontal_align), [`VerticalAlign`](#vertical_align), [`Top`](#top) и [`Left`](#left) (в порядке значимости), либо как значение WindowsDefaultLocation. ### FormState Тип состояния формы. Необязательный атрибут. Ожидается название одного из типов состояния формы:


Minimized	Форма свернута в панель задач (данное значение можно задать только через set-проперти в процессе работы формы)
Maximized	Форма развернута на весь экран
Normal	Обычное положение формы: ни свернута в панель задач, ни развернута на весь экран

Если атрибут `FormState` отсутствует, то используется значение Normal. ### AutoScroll Признак, определяющий, показывать ли полосы прокрутки на форме, если объекты не входят в ее рабочую область. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение False. ### FontStyle Имя стиля шрифта формы по умолчанию. Необязательный атрибут. Ожидается имя одного из стилей шрифтов, описанных в форме. По умолчанию используется стандартное значение .NET. ### ForeColor Имя цвета текста формы по умолчанию. Необязательный атрибут. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется стандартное значение .NET. ### BackColor Имя цвета фона формы. Необязательный атрибут. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется стандартное значение .NET. ### TransparencyColor Имя цвета, который форма будет определять как прозрачный. Необязательный атрибут. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ### BackgroundImage Путь до файла с графическим содержанием, которое будет расположено на форме. Необязательный атрибут. Любое значение будет переведено в текстовое. ### StatusBar Признак отображения бара событий формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение False. ### DiagMessage Признак показа диагностического сообщения с результатами загрузки сущностей формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение False. ### FormBorderStyle Тип границ формы. Необязательный атрибут. Ожидается название одного из типов границы формы:


None	Нет границы
FixedSingle	Фиксированная граница из одной линии
Fixed3D	Фиксированная трехмерная граница
FixedDialog	Толстая фиксированная граница стиля диалогового окна
Sizable	Граница с изменяемыми размерами
FixedToolWindow	Неизменяемая граница окна инструментов (окно инструментов не отображается ни на панели задач, ни в окне, появляющемся при нажатии пользователем сочетания клавиш ALT+TAB)
SizableToolWindow	Изменяемая граница окна инструментов (окно инструментов не отображается ни на панели задач, ни в окне, появляющемся при нажатии пользователем сочетания клавиш ALT+TAB)

По умолчанию используется значение FixedSingle. ### ControlBox Признак, определяющий, отображаются или нет кнопки оконного меню в строке заголовка формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### MinimizeBox Признак, определяющий, отображается ли кнопка свертывания в строке заголовка формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### MaximizeBox Признак, определяющий, отображается ли кнопка развертывания в строке заголовка формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### ShowInTaskbar Признак, определяющий, отображается ли форма в панели задач. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### TopMost Признак, определяющий, необходимо ли отображать форму как форму переднего плана. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение False. ### Opacity Уровень непрозрачности формы. Необязательный атрибут. Ожидается числовое значение (от 0 до 1). По умолчанию используется значение 1. ### KeyPreview Признак, определяющий, будет ли форма получать события нажатия клавиш с объектов, на ней расположенных. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### ValidationType Вид `Checking` формы. Необязательный атрибут. Ожидается название одного из типов `Checking`:


Asterisk	"Звёздочка" справа от объекта
Flat	Полоска слева от объекта

По умолчанию используется значение Asterisk. ### FlatWidth Ширина цвета полосы `Checking` формы. Необязательный атрибут. Ожидается числовое значение. По умолчанию используется значение 3. ### FlatColor Имя цвета полосы `Checking` формы. Необязательный атрибут. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется красный цвет. ### AsteriskForeColor Имя цвета "звездочки" формы. Необязательный атрибут. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется стандартное значение .NET для надписи. ### AsteriskFontStyle Имя стиля шрифта "звездочки" формы. Необязательный атрибут. Ожидается имя одного из стилей шрифтов, описанных в форме. По умолчанию используется стандартное значение .NET для надписи. ### EnableWaitingAnimation Признак, определяющий, будет ли отображаться форма с анимацией. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### EnableWaitingAnimationWhileActive Признак, определяющий, что форма с анимацией будет отображаться только тогда, когда окно активно. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение False. ### RestoreLastFormState Признак, определяющий, будет ли восстановлено предыдущее состояние формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение True. ### Icon Путь до файла иконки. Необязательный атрибут. Любое значение будет переведено в текстовое. ### TabAutoSelect Признак, определяющий, будет ли выполняться автоматическая установка фокуса в первом элементе управления при запуске формы. Необязательный атрибут. Ожидается логическое значение. По умолчанию используется значение False. ## Тэги, специфичные для Form ### StartLocale Единоразово устанавливает локаль и язык перевода для всего приложения при загрузке формы. Необязательный тэг. Ожидается код одной из локалей, поддерживаемых Windows. Если тэг `` отсутствует, то для приложения устанавливается язык операционной системы пользователя. Полный список всех кодов локалей можно посмотреть по [ссылке](https://msdn.microsoft.com/en-us/library/cc233982.aspx). {% hint style="warning" %} Установка локали происходит только один раз в момент загрузки формы, любое изменение универсального значения внутри (например, [`DataConnection`](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/dataconnections)) язык приложения не изменяет. {% endhint %} ```xml ``` ### Appearance Содержит графические настройки отображения формы. Необязательный тэг. Значение тэга ``: см. в разделе [Appearance](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/appearance). ```xml ``` ### Includes Содержит документы, содержимое которых будет включено в текущий документ. Необязательный тэг. Значение тэга ``: см. в разделе [Includes](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/includes). ```xml ``` ### Parameters Содержит описание параметров формы. Необязательный тэг. Значение тэга ``: см. в разделе [Parameters](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/parameters). ```xml ``` ### DataConnections Содержит описание соединений с данными. Необязательный тэг. Значение тэга ``: см. в разделе [DataConnections](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/dataconnections). ```xml ``` ### Conditions Содержит описание условий. Необязательный тэг. Значение тэга ``: см. в разделе [Conditions](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/conditions). ```xml ``` ### Commands Содержит описание команд. Необязательный тэг. Значение тэга ``: см. в разделе [Commands](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/commands). ```xml ``` ### Executions Содержит описание действий. Необязательный тэг. Значение тэга ``: см. в разделе [Executions](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/executions). ```xml ``` ### Checkings Содержит описание проверок. Необязательный тэг. Значение тэга ``: см. в разделе [Checkings](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/checkings). ```xml ``` ### MainMenu Содержит описание главного меню формы. Необязательный тэг. Значение тэга ``: см. в разделе [Menus](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/menus). ```xml ``` ### ContextMenus Содержит описание контекстных меню формы. Необязательный тэг. Значение тэга ``: см. в разделе [Menus](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/menus). ```xml ``` ### MyObjects Содержит описание объектов формы. Необязательный тэг. Значение тэга ``: см. в разделе [Objects](https://wfsys.gitbook.io/workflow-forms-syntax/workflow_forms/objects). ```xml ``` ## Get-проперти для получения свойств ### Title Возвращает заголовок формы. ```xml

``` ### Top Возвращает координату расположения формы по высоте (сверху вниз). ```xml

``` ### Left Возвращает координату расположения формы по ширине (слева направо). ```xml

``` ### Height Возвращает высоту рабочей области формы (то есть кайма формы сюда не входит). ```xml

``` ### Width Возвращает ширину рабочей области формы (то есть кайма формы сюда не входит). ```xml

``` ### TotalHeight Возвращает полную высоту формы (с учетом каймы). ```xml

``` ### TotalWidth Возвращает полную ширину формы (с учетом каймы). ```xml

``` ### FormState Возвращает тип состояния формы. ```xml

``` ### AutoScroll Возвращает признак, определяющий, показываются ли полосы прокрутки на форме, если объекты не входят в ее рабочую область. ```xml

``` ### FontStyle Возвращает имя стиля шрифта формы по умолчанию. ```xml

``` ### ForeColor Возвращает имя цвета текста формы по умолчанию. ```xml

``` ### BackColor Возвращает имя цвета фона формы. ```xml

``` ### TransparencyColor Возвращает имя цвета, который форма определяет как прозрачный. ```xml

``` ### BackgroundImage Возвращает путь до файла с графическим содержанием, которое расположено на форме. ```xml

``` ### StatusBar Возвращает признак отображения бара событий формы. ```xml

``` ### DiagMessage Возвращает признак показа диагностического сообщения с результатами загрузки сущностей формы. ```xml

``` ### FormBorderStyle Возвращает тип границ формы. ```xml

``` ### ControlBox Возвращает признак, определяющий, отображаются или нет кнопки оконного меню в строке заголовка формы. ```xml

``` ### MinimizeBox Возвращает признак, определяющий, отображается ли кнопка свертывания в строке заголовка формы. ```xml

``` ### MaximizeBox Возвращает признак, определяющий, отображается ли кнопка развертывания в строке заголовка формы. ```xml

``` ### ShowInTaskbar Возвращает признак, определяющий, отображается ли форма в панели задач. ```xml

``` ### TopMost Возвращает признак, определяющий, отображается ли форма как форма переднего плана. ```xml

``` ### Opacity Возвращает уровень непрозрачности формы. ```xml

``` ### KeyPreview Возвращает признак, определяющий, получает ли форма события нажатия клавиш с объектов, на ней расположенных. ```xml

``` ### LastKeys Возвращает строку, содержащую символы, соответствующие последним нажатым клавишам (при условии, что атрибут`KeyPreview` формы имеет значение True). Например, возвращаемые значения могут выглядеть следующим образом: 1. A 2. A, B 3. AB 4. Ctrl + A 5. Ctrl + A + B 6. Ctrl + A + B, Shift + C 7. Ctrl+Alt + A, Alt+Shift + B 8. Ctrl+Alt+Shift + A, Alt+Shift + B + C 9. И другие варианты ```xml ``` ### AsteriskForeColor Возвращает имя цвета "звездочки" формы. ```xml

``` ### AsteriskFontStyle Возвращает имя стиля шрифта "звездочки" формы. ```xml

``` ### DateTimeNow Возвращает рабочую дату и время формы, определенную первый раз в момент открытия формы. ```xml

``` ### FormChanged Возвращает признак изменения формы (определяется как совокупность get-проперти `ValueChanged` объектов на форме). ```xml

``` ### EnableWaitingAnimation Возвращает признак, определяющий, отображается ли форма с анимацией. ```xml

``` ### EnableWaitingAnimationWhileActive Возвращает признак, определяющий, что форма с анимацией отображается только тогда, когда окно активно. ```xml

``` ### RestoreLastFormState Возвращает признак, определяющий, восстанавливается ли предыдущее состояние формы. ```xml

``` ### ChangedObjects Возвращает список изменённых объектов. ```xml

``` ### CheckingFired Возвращает признак, определяющий, сработал ли хоть один [``](#checkings). Если в качестве параметра передано имя группы, то возвращает признак, определяющий, сработал ли хоть один [``](#checkings) в группе. ```xml

``` ```xml ``` ### Icon Возвращает путь до файла иконки. ```xml

``` ### IsActive Возвращает признак, определяющий, что форма активна. ```xml

``` ### LoadMode Возвращает идентификатор выбранного режима загрузки данных. ```xml

``` Возвращает одно из значений:


0	Последовательный режим - загрузка соединений с данными будет происходить по очереди. Обеспечивает минимальную скорость загрузки форм, при этом требует минимальное количество ресурсов со стороны сервера.
1	Пакетный режим. Обеспечивает стандартную скорость загрузки форм, при этом не требует значительного количества ресурсов со стороны сервера.
2	Параллельный режим. Режим по умолчанию. Обеспечивает увеличенную скорость загрузки форм, однако при этом требует максимальное количество ресурсов со стороны сервера.

Последовательный режим - загрузка соединений с данными будет происходить по очереди.

Обеспечивает минимальную скорость загрузки форм, при этом требует минимальное количество ресурсов со стороны сервера.

Пакетный режим.

Обеспечивает стандартную скорость загрузки форм, при этом не требует значительного количества ресурсов со стороны сервера.

Параллельный режим. Режим по умолчанию.

Обеспечивает увеличенную скорость загрузки форм, однако при этом требует максимальное количество ресурсов со стороны сервера.

## Set-проперти для динамического задания свойств ### Title Задает заголовок формы. Любое значение будет переведено в текстовое. ```xml ``` ### Top Задает координату расположения формы по высоте (сверху вниз). Ожидается целочисленное значение. ```xml ``` ### Left Задает координату расположения формы по ширине (слева направо). Ожидается целочисленное значение. ```xml ``` ### Height Задает высоту рабочей области формы (то есть кайма формы сюда не входит). Ожидается целочисленное значение. ```xml ``` ### Width Задает ширину рабочей области формы (то есть кайма формы сюда не входит). Ожидается целочисленное значение. ```xml ``` ### TotalHeight Задает полную высоту формы (с учетом каймы). Ожидается целочисленное значение. ```xml ``` ### TotalWidth Задает полную ширину формы (с учетом каймы). Ожидается целочисленное значение. ```xml ``` ### HorizontalAlign Задает тип положения формы по горизонтали. Ожидается название одного из типов положения формы по горизонтали. ```xml ``` ### VerticalAlign Задает тип положения формы по вертикали. Ожидается название одного из типов положения формы по вертикали. ```xml ``` ### StartPosition Задает тип положения формы на экране. Ожидается название одного из типов положения формы на экране. ```xml ``` ### CenterToScreen Выравнивает форму по центру текущего экрана. Значение не ожидается. ```xml

``` ### FormState Задает тип состояния формы. Ожидается название одного из типов состояния формы. ```xml ``` ### AutoScroll Задает признак, определяющий, показывать ли полосы прокрутки на форме, если объекты не входят в ее рабочую область. Ожидается логическое значение. ```xml ``` ### FontStyle Задает имя стиля шрифта формы по умолчанию. Ожидается имя одного из стилей шрифтов, описанных в форме. ```xml ``` ### ForeColor Задает имя цвета текста формы по умолчанию. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml ``` ### BackColor Задает имя цвета фона формы. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml ``` ### TransparencyColor Задает имя цвета, который форма будет определять как прозрачный. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml ``` ### BackgroundImage Задает путь до файла с графическим содержанием, которое будет расположено на форме. Любое значение будет переведено в текстовое. ```xml ``` ### StatusBar Задает признак отображения бара событий формы. Ожидается логическое значение. ```xml ``` ### FormBorderStyle Задает тип границы формы. Ожидается название одного из типов границы формы. ```xml ``` ### ControlBox Задает признак, определяющий, отображаются или нет кнопки оконного меню в строке заголовка формы. Ожидается логическое значение. ```xml ``` ### MinimizeBox Задает признак, определяющий, отображается ли кнопка свертывания в строке заголовка формы. Ожидается логическое значение. ```xml ``` ### MaximizeBox Задает признак, определяющий, отображается ли кнопка развертывания в строке заголовка формы. Ожидается логическое значение. ```xml ``` ### ShowInTaskbar Задает признак, определяющий, отображается ли форма в панели задач. Ожидается логическое значение. ```xml ``` ### TopMost Задает признак, определяющий, необходимо ли отображать форму как форму переднего плана. Ожидается логическое значение. ```xml ``` ### Opacity Задает уровень непрозрачности формы. Ожидается числовое значение (от 0 до 1). ```xml ``` ### KeyPreview Задает признак, определяющий, будет ли форма получать события нажатия клавиш с объектов, на ней расположенных. Ожидается логическое значение. ```xml ``` ### AsteriskForeColor Задает имя цвета "звездочки" формы. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml ``` ### AsteriskFontStyle Задает имя стиля шрифта "звездочки" формы. Ожидается имя одного из стилей шрифтов, описанных в форме. ```xml ``` ### DateTimeNow Задает рабочую дату и время формы, определенную первый раз в момент открытия формы. Ожидается значение типа дата/время. ```xml ``` ### RefreshDateTimeNow Задает рабочую дату и время формы, равную текущей дате и времени. Значение тэга ``: не ожидается. ```xml

``` ### FormChanged Задает признак изменения формы (определяется как совокупность get-проперти `ValueChanged` объектов на форме). Если `FormChanged` присваивается значение False, то проперти `ValueChanged` всех объектов формы тоже приобретут значение False. Ожидается логическое значение. ```xml ``` ### EnableWaitingAnimation Задает признак, определяющий, будет ли отображаться форма с анимацией. Ожидается логическое значение. ```xml ``` ### EnableWaitingAnimationWhileActive Задает признак, определяющий, что форма с анимацией будет отображаться только тогда, когда окно активно. Ожидается логическое значение. ```xml ``` ### RestoreLastFormState Задает признак, определяющий, будет ли восстановлено предыдущее состояние формы. Ожидается логическое значение. ```xml ``` ### Icon Задает иконку формы. Любое значение будет переведено в текстовое. ```xml ```