> For the complete documentation index, see [llms.txt](https://wfsys.gitbook.io/workflow-web-forms-syntax/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wfsys.gitbook.io/workflow-web-forms-syntax/workflow_webforms/objects/button.md). # Button ## Шаблон Button Перечень всех возможных тэгов объекта: ```xml ``` ## Описание Button ```xml ``` Значением Button считается текст, указанный на кнопке. ### Получение значения Button Для получения указанного на кнопке текста используется get-проперти [Text](#text-1): ```xml ``` Рекомендуется использовать сокращенный вариант записи: ```xml ``` ### Задание значения Button Для задания отображаемого на кнопке текста используется set-проперти [Text](#set_text): ```xml Text ``` Рекомендуется использовать сокращенный вариант записи: ```xml Text ``` ## Тэги, специфичные для Button ### FlatBorderSize Толщина границы кнопки (в пикселях). Необязательный тэг. Ожидается целочисленное значение. По умолчанию используется значение 1. ```xml 1 ``` ### FlatBorderColor Цвет границы кнопки. Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). По умолчанию используется значение #d3d3d3 (светло-серый). ```xml FlatBorderColor ``` ### FlatMouseDownBackColor Цвет фона нажатой кнопки. Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). Если тэг `` отсутствует, то цвет рассчитывается автоматически. ```xml FlatMouseDownBackColor ``` ### FlatMouseOverBackColor Цвет фона кнопки при наведении курсора мыши. Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). Если тэг `` отсутствует, то цвет рассчитывается автоматически. ```xml FlatMouseOverBackColor ``` ### Image Путь до файла с графическим содержанием, которое будет расположено на кнопке. Необязательный тэг. Любое значение будет переведено в текстовое. ```xml Image ``` ### ImageAlign Тип положения картинки. Необязательный тэг. Ожидается название одного из типов положения картинки:
TopLeftСлева сверху
TopCenterПо центру сверху
TopRightСправа сверху
MiddleLeftСлева посередине
MiddleCenterПо центру посередине
MiddleRightСправа посередине
BottomLeftСлева снизу
BottomCenterПо центру снизу
BottomRightСправа снизу
По умолчанию используется значение MiddleCenter**.** ```xml MiddleCenter ``` ### Icon Иконка, которая будет расположена на кнопке. Необязательный тэг. Любое значение будет переведено в текстовое. Ожидается название одного из типов иконок Google. Список иконок доступен по [ссылке](https://www.w3schools.com/icons/icons_reference.asp). ```xml keyboard_arrow_down ``` ### TextAlign Тип положения текста. Необязательный тэг. Ожидается название одного из типов положения текста:
TopLeftСлева сверху
TopCenterПо центру сверху
TopRightСправа сверху
MiddleLeftСлева посередине
MiddleCenterПо центру посередине
MiddleRightСправа посередине
BottomLeftСлева снизу
BottomCenterПо центру снизу
BottomRightСправа снизу
По умолчанию используется значение MiddleLeft. ```xml MiddleLeft ``` ### Text Текст на кнопке. Необязательный тэг. Любое значение будет переведено в текстовое. ```xml Текст ``` ### DisabledMode Признак, при установке которого при нажатии на неактивную кнопку (Enabled = False) будет показано сообщение с текстом, указанным в тэге [``](#disabled_text). Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### DisabledText Текст сообщения, которое будет показано по нажатию на неактивную кнопку с установленным признаком [``](#disabledmode). Необязательный тэг. Любое значение будет переведено в текстовое. ```xml Текст сообщения ``` ### Commands Список команд, которые будут выполнены при нажатии на кнопку. Необязательный тэг. В качестве значения тэга ожидается список тэгов [``](#teg-less-than-command-greater-than) и/или конструкций [``](/workflow-web-forms-syntax/workflow_webforms/values/if.md). ```xml input 1 input 2 ``` #### Атрибуты тэга ``
StopOnError

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

Необязательный атрибут. Ожидается логическое значение.

По умолчанию используется значение True.

Lock

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

Необязательный атрибут. Ожидается логическое значение.

По умолчанию используется значение False.

#### Тэг `` Обращение к команде по имени для ее выполнения. Необязательный тэг. В качестве значения тэга ожидается список тэгов [``](/workflow-web-forms-syntax/workflow_webforms/values/input.md). ```xml input 1 input 2 ``` ## Get-проперти для получения свойств ### FlatBorderSize Возвращает ширину границы кнопки. ```xml ``` ### FlatBorderColor Возвращает имя цвета границы плоской кнопки. ```xml ``` ### FlatMouseDownBackColor Возвращает имя цвета нажатой кнопки. ```xml ``` ### FlatMouseOverBackColor Возвращает имя цвета кнопки при наведении курсора мыши. ```xml ``` ### Image Возвращает путь до файла с графическим содержанием, которое будет расположено на кнопке. ```xml ``` ### ImageAlign Возвращает название типа положения картинки. ```xml ``` ### Icon Возвращает название иконки, которая расположена на кнопке. ```xml ``` ### TextAlign Возвращает название типа положения текста. ```xml ``` ### Text Возвращает текст на кнопке. ```xml ``` ### DisabledMode Возвращает значение признака [``](#disabled_mode). ```xml ``` ### DisabledText Возвращает текст сообщения, заданное для признака [``](#disabled_text). ```xml ``` ## Set-проперти для динамического задания свойств ### FlatBorderSize Задает ширину границы кнопки. Ожидается целочисленное значение. ```xml 1 ``` ### FlatBorderColor Задает цвет границы кнопки. Ожидается название одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml FlatBorderColor ``` ### FlatMouseDownBackColor Задает цвет нажатой кнопки. Ожидается название одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml FlatMouseDownBackColor ``` ### FlatMouseOverBackColor Задает цвет кнопки при наведении курсора мыши. Ожидается название одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb). ```xml FlatMouseOverBackColor ``` ### Image Задает путь до файла с графическим содержанием, которое будет расположено на кнопке. Любое значение будет переведено в текстовое. ```xml ``` ### ImageAlign Задает название типа положения картинки. Ожидается одно из названий типов положения картинки. ```xml TopLeft ``` ### Icon Задает иконку, которая будет расположена на кнопке. Любое значение будет переведено в текстовое. ```xml ``` ### TextAlign Задает название типа положения текста. Ожидается одно из названий типов положения текста. ```xml TopLeft ``` ### Text Задает текст на кнопке. Любое значение будет переведено в текстовое. ```xml Text ``` ### DisabledMode Задает значение признака [``](#disabled_mode). ```xml ``` ### DisabledText Задает текст сообщения для признака [``](#disabled_text). ```xml ```