> 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/textbox.md). # TextBox ## Шаблон TextBox Перечень всех возможных тэгов объекта: ```xml ``` ## Описание TextBox ```xml ``` Значением `TextBox` считается текст, указанный в поле. ### Получение значения TextBox Для получения указанного в поле текста используется get-проперти [`Text`](#get_text): ```xml ``` Рекомендуется использовать сокращенный вариант записи: ```xml ``` ### Задание значения TextBox Для задания значения текстовому полю используется set-проперти [`Text`](#set_text): ```xml Текст ``` Рекомендуется использовать сокращенный вариант записи: ```xml Текст ``` ## Тэги, специфичные для TextBox ### MaxLength Задает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 0, показывающее, что ограничения нет. ```xml 0 ``` ### ReadOnly Указывает, доступно ли текстовое поле только для чтения или для чтения и редактирования. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### Multiline Задает значение, показывающее, является ли данный элемент управления многострочным текстовым полем. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### Password Признак, разрешающий ввод пароля.\ Пользователь увидит только символы звездочек ( \* ). Игнорируется при наличии тэга [``](#multiline). Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### AllowedSymbols Задает набор символов, которые разрешено вводить в поле.\ Пустая строка соответствует запрету вводить вообще какие-либо символы. Необязательный тэг. Любое значение будет переведено в текстовое. Если тэг отсутствует, то можно вводить любые символы. ```xml 0123456789 ``` ### InputLanguage Задает ограничение на язык вводимых символов.\ Если язык вводимого символа не совпадает с языком, указанным в данном тэге, то этот символ будет трансформирован в символ другого языка, расположенный на этой же клавише клавиатуры. Необязательный тэг. Ожидается одно из допустимых значений:
RusРусский язык
EngАнглийский язык
NoneБез ограничений по языку
По умолчанию используется значение None. ```xml None ``` Например, при значении Rus вводимая последовательность символов "qwerty" будет преобразована в "йцукен". ### InputCase Задает ограничение на регистр вводимых символов.\ Если регистр вводимого символа не совпадает с регистром, указанном в данном тэге, то этот символ будет трансформирован в указанный регистр. Необязательный тэг. Ожидается одно из допустимых значений:
UpperВерхний регистр
LowerНижний регистр
NoneБез ограничений по регистру
По умолчанию используется значение None. ```xml None ``` ### SelectOnEnter Признак, определяющий, будет ли выделено содержимое поля после получения им фокуса. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### TipText Задает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL. Необязательный тэг. Любое значение будет переведено в текстовое. ```xml Текст подсказки ``` ### TextAlign Используется, чтобы указать способ выравнивания текста по горизонтали. Необязательный тэг. Ожидается одно из допустимых значений:
LeftСлева
CenterПо центру
RightСправа
По умолчанию используется значение Left. ```xml Left ``` ### Text Задает значение текстового поля. Необязательный тэг. Любое значение будет переведено в текстовое. По умолчанию используется пустая строка. ```xml Текст ``` ### ScrollBars Тип полос прокрутки, показывающий, какие полосы прокрутки должны присутствовать в многострочном поле.\ Используется при установленном тэге [``](#multiline). Необязательный тэг. Ожидается одно из допустимых значений:
AutoАвтоматические полосы прокрутки
VerticalВертикальная полоса прокрутки
HorizontalГоризонтальная полоса прокрутки
BothВертикальная и горизонтальная полосы прокрутки
NoneБез полос прокрутки
По умолчанию используется значение Auto. ```xml Vertical ``` ## Get-проперти для получения свойств ### MaxLength Возвращает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле. ```xml ``` ### ReadOnly Возвращает значение, определяющее, доступно ли текстовое поле только для чтения или для чтения и редактирования. ```xml ``` ### Multiline Возвращает значение, показывающее, является ли данный элемент управления многострочным текстовым полем. ```xml ``` ### Password Возвращает значение признака ввода пароля в поле. ```xml ``` ### AllowedSymbols Возвращает набор символов, которые разрешено вводить в поле. ```xml ``` ### InputLanguage Возвращает название языка, к которому будут преобразовываться вводимые символы. ```xml ``` ### InputCase Возвращает название регистра, к которому будут преобразовываться вводимые символы. ```xml ``` ### SelectOnEnter Возвращает значение признака, определяющего, будет ли выделено содержимое поля после получения им фокуса. ```xml ``` ### TipText Возвращает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL. ```xml ``` ### TextAlign Возвращает способ выравнивания текста по горизонтали. ```xml ``` ### Text Возвращает значение текстового поля. ```xml ``` ### Length Возвращает длину текста, введенного в поле. ```xml ``` ### ScrollBars Возвращает тип полос прокрутки, показывающий, какие полосы прокрутки должны присутствовать в многострочном поле. ```xml ``` ## Set-проперти для динамического задания свойств ### MaxLength Задает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле. Ожидается положительное целочисленное значение. ```xml 200 ``` ### ReadOnly Задает значение, определяющее, доступно ли поле только для чтения или для чтения и редактирования. Ожидается логическое значение. ```xml True ``` ### Multiline Задает значение, показывающее, является ли данный элемент управления многострочным текстовым полем.\ Если тэг [``](#mask) присутствует в описании объекта, то любое переданное значение игнорируется. Ожидается логическое значение. ```xml True ``` ### Password Задает значение признака ввода пароля в поле.\ Если тэг [``](#mask) присутствует в описании объекта, то любое переданное значение игнорируется. Ожидается логическое значение. ```xml True ``` ### AllowedSymbols Задает набор символов, которые разрешено вводить в поле. Любое значение будет переведено в текстовое. ```xml 0123,. ``` ### InputLanguage Задает правила трансформации языка вводимых символов. Ожидается одно из допустимых значений, указанных в описании тэга [``](#input_language). ```xml Rus ``` ### InputCase Задает название языка, к которому будут преобразовываться вводимые символы. Ожидается одно из допустимых значений, указанных в описании тэга [``](#input_case). ```xml Lower ``` ### SelectOnEnter Задает значение признака, определяющего, будет ли выделено содержимое поля после получения им фокуса. Ожидается логическое значение. ```xml True ``` ### TipText Задает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL. Любое значение будет переведено в текстовое. ```xml Текст ``` ### TextAlign Задает способ выравнивания текста по горизонтали.\ Если тэг [``](#mask) присутствует в описании объекта, то любое переданное значение игнорируется. Ожидается одно из допустимых значений, указанных в описании тэга [``](#text_align). ```xml Right ``` ### Text Задает значение текстового поля. Любое значение будет переведено в текстовое. ```xml Текст ``` ### AppendText Дописывает поле заданным текстом и переводит курсор в конец поля. Любое значение будет переведено в текстовое. ```xml Текст ``` ### ScrollBars Задает тип полос прокрутки, показывающий, какие полосы прокрутки должны присутствовать в многострочном поле.\ Используется при установленном тэге [``](#multiline). Ожидается одно из допустимых значений, указанных в описании тэга [``](#scroll_bars). ```xml Horizontal ```