# TextBox ## Шаблон TextBox Перечень всех возможных тэгов объекта: ```xml ``` ## Описание TextBox ```xml ``` Значением TextBox считается текст, указанный в поле. ### Получение значения Для получения указанного в поле текста используется get-проперти [Text](#get_text): ```xml ``` Рекомендуется использовать сокращенный вариант записи: ```xml ``` ### Задание значения Для задания значения текстовому полю используется set-проперти [Text](#set_text): ```xml Текст ``` Рекомендуется использовать сокращенный вариант записи: ```xml Текст ``` ## Тэги, специфичные для TextBox ### MaxLength Задает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле. Необязательный тэг. Ожидается положительное целочисленное значение. По умолчанию используется значение 0, показывающее, что ограничения нет. ```xml 0 ``` ### ReadOnly Указывает, доступно ли текстовое поле только для чтения или для чтения и редактирования. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### Multiline Задает значение, показывающее, является ли данный элемент управления многострочным текстовым полем.\ Игнорируется при наличии тэга [``](#mask). Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### Password Признак, разрешающий ввод пароля.\ Пользователь увидит только символы звездочек ( \* ). Игнорируется при наличии тэга [``](#mask). Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### ShowPasswordButton Признак, определяющий, будет ли показана кнопка просмотра введенных символов.\ Игнорируется, если тэг `` отсутствует. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. 
<ShowPasswordButton>True</ShowPasswordButton>
Если в тэге `` явно задано значение False, а в тэге `` стоит значение True, то текстовое поле будет работать в режиме ввода пароля с отображением введенных символов. ### AllowedSymbols Задает набор символов, которые разрешено вводить в поле.\ Пустая строка соответствует запрету вводить вообще какие-либо символы. Необязательный тэг. Любое значение будет переведено в текстовое. Если тэг отсутствует, то можно вводить любые символы. ```xml 0123456789 ``` ### InputLanguage Задает ограничение на язык вводимых символов.\ Если язык вводимого символа не совпадает с языком, указанным в данном тэге, то этот символ будет трансформирован в символ другого языка, расположенный на этой же клавише клавиатуры. Необязательный тэг. Ожидается одно из допустимых значений:
RusРусский язык
EngАнглийский язык
NoneБез ограничений по языку
По умолчанию используется значение None. ```xml None ``` Например, при значении Rus вводимая последовательность символов "qwerty" будет преобразована в "йцукен". ### InputCase Задает ограничение на регистр вводимых символов.\ Если регистр вводимого символа не совпадает с регистром, указанном в данном тэге, то этот символ будет трансформирован в указанный регистр. Необязательный тэг. Ожидается одно из допустимых значений:
UpperВерхний регистр
LowerНижний регистр
NoneБез ограничений по регистру
По умолчанию используется значение None. ```xml None ``` ### SelectOnEnter Признак, определяющий, будет ли выделено содержимое поля после получения им фокуса. Необязательный тэг. Ожидается логическое значение. По умолчанию используется значение False. ```xml False ``` ### Mask Маска ввода текстового поля.\ При наличии тэга `` поля [``](#multiline), [``](#password) и [``](#text_align) объекта игнорируются.\ Если тэг `` отсутствует, то маска ввода не используется и не сможет в дальнейшем быть установлена. Пустая строка соответствует отсутствию маски, при этом поля [``](#multiline), [``](#password) и [``](#text_align) объекта по-прежнему игнорируются. Необязательный тэг. Любое значение будет переведено в текстовое. ```xml AA-00 ``` Все поддерживаемые элементы в выражении для задания маски ввода смотрите по [ссылке](https://docs.microsoft.com/en-us/dotnet/api/system.windows.forms.maskedtextbox.mask?redirectedfrom=MSDN\&view=windowsdesktop-6.0#remarks). Для задания маски номера телефона используется служебное слово `PHONE`, которое переключает текстовое поле в режим ввода номера телефона. При этом маска выбирается автоматически на основе зоны и кода страны. Подробнее по ссылкам [здесь](https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D0%BB%D0%B5%D1%84%D0%BE%D0%BD%D0%BD%D1%8B%D0%B5_%D0%BA%D0%BE%D0%B4%D1%8B_%D1%81%D1%82%D1%80%D0%B0%D0%BD) и [здесь](https://ru.wikipedia.org/wiki/%D0%A2%D0%B5%D0%BB%D0%B5%D1%84%D0%BE%D0%BD%D0%BD%D1%8B%D0%B5_%D0%BF%D0%BB%D0%B0%D0%BD%D1%8B_%D0%BD%D1%83%D0%BC%D0%B5%D1%80%D0%B0%D1%86%D0%B8%D0%B8_%D0%B2_%D1%80%D0%B0%D0%B7%D0%BD%D1%8B%D1%85_%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B0%D1%85). ```xml PHONE ``` ### TipText Задает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL. Необязательный тэг. Любое значение будет переведено в текстовое. ```xml Текст подсказки ``` ### TextAlign Используется, чтобы указать способ выравнивания текста по горизонтали.\ Игнорируется при наличии тэга [``](#mask). Необязательный тэг. Ожидается одно из допустимых значений:
LeftСлева
CenterПо центру
RightСправа
По умолчанию используется значение Left. ```xml Left ``` ### Text Задает значение текстового поля. Необязательный тэг. Любое значение будет переведено в текстовое. По умолчанию используется пустая строка. ```xml Текст ``` ### ScrollBars Тип полос прокрутки, показывающий, какие полосы прокрутки должны присутствовать в многострочном поле.\ Используется при установленном тэге [``](#multiline). Необязательный тэг. Ожидается одно из допустимых значений:
VerticalВертикальная полоса прокрутки
HorizontalГоризонтальная полоса прокрутки
BothВертикальная и горизонтальная полосы прокрутки
NoneБез полос прокрутки
По умолчанию используется значение Vertical. ```xml Vertical ``` ### BorderStyle Задает тип границы элемента. Необязательный тэг. Ожидается одно из допустимых значений:
FixedSingleОдиночная плоская граница
Fixed3DОдиночная объемная граница
NoneНет границы
По умолчанию используется значение FixedSingle. ```xml Fixed3D ``` ## Get-проперти для получения свойств ### MaxLength Возвращает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле. ```xml ``` ### ReadOnly Возвращает значение, определяющее, доступно ли текстовое поле только для чтения или для чтения и редактирования. ```xml ``` ### Multiline Возвращает значение, показывающее, является ли данный элемент управления многострочным текстовым полем. ```xml ``` ### Password Возвращает значение признака ввода пароля в поле. ```xml ``` ### AllowedSymbols Возвращает набор символов, которые разрешено вводить в поле. ```xml ``` ### InputLanguage Возвращает название языка, к которому будут преобразовываться вводимые символы. ```xml ``` ### InputCase Возвращает название регистра, к которому будут преобразовываться вводимые символы. ```xml ``` ### SelectOnEnter Возвращает значение признака, определяющего, будет ли выделено содержимое поля после получения им фокуса. ```xml ``` ### Mask Возвращает маску ввода текстового поля. ```xml ``` ### TipText Возвращает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL. ```xml ``` ### TextAlign Возвращает способ выравнивания текста по горизонтали. ```xml ``` ### Text Возвращает значение текстового поля. ```xml ``` ### MaskCompleted Возвращает значение, показывающее, все ли обязательные входные данные введены в маску ввода. ```markup ``` #### Пример Если у текстового поля задана маска вида: ```xml 0000#? ``` * 0 - обязательный символ, принимает любую цифру от 0 до 9; * \\# - необязательный символ, принимает любую цифру от 0 до 9 или пробел. Допускаются знаки плюс (+) и минус (-); * ? - необязательный символ, принимает буквы таблицы ASCII. Если в поле будут введены все обязательные цифры, то get-проперти MaskCompleted вернет значение true. Если будет отсутствовать хотя бы одна обязательная цифра, то будет возвращено значение false. ### MaskFull Возвращает значение, показывающее, все ли обязательные и необязательные входные данные были введены в маску ввода. ```markup ``` #### Пример Если у текстового поля задана маска вида: ```xml 0000#? ``` Если в поле будет введена строка вида "1234-A", то get-проперти MaskFull вернет значение true. Если будет отсутствовать хотя бы один любой символ, то будет возвращено значение false. ### WordByNumber Возвращает целое слово с указанным порядковым номером, извлеченное из значения поля.\ Символами-разделителями между словами считаются " ", ",", ".", ";". Ожидается целочисленное положительное значение. ```xml 1 ``` Например, для строки "слово1 слово2" свойство со значением 2 вернет "слово2". ### Length Возвращает длину текста, введенного в поле. ```xml ``` ### ScrollBars Возвращает тип полос прокрутки, показывающий, какие полосы прокрутки должны присутствовать в многострочном поле. ```xml ``` ### BorderStyle Возвращает тип границы элемента. ```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 ``` ### Mask Задает маску ввода текстового поля.\ Если тэг [``](#mask) отсутствует в описании объекта, то маска не будет установлена. Любое значение будет переведено в текстовое. Полные правила указания маски ввода указаны в описании тэга [``](#mask). ```xml ###.## ``` ### TipText Задает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL. Любое значение будет переведено в текстовое. ```xml Текст ``` ### TextAlign Задает способ выравнивания текста по горизонтали.\ Если тэг [``](#mask) присутствует в описании объекта, то любое переданное значение игнорируется. Ожидается одно из допустимых значений, указанных в описании тэга [``](#text_align). ```xml Right ``` ### Text Задает значение текстового поля. Любое значение будет переведено в текстовое. ```xml Текст ``` ### AppendText Дописывает поле заданным текстом и переводит курсор в конец поля. Любое значение будет переведено в текстовое. ```xml Текст ``` ### InsertAtCursorPosition Вставляет заданный текст на место курсора и после переводит курсор в конец добавленного текста.\ Если поле не содержит фокуса, то тогда вставляемый текст добавляется в конец строки, и поле получает фокус. Любое значение будет переведено в текстовое. ```xml Текст ``` ### ScrollBars Задает тип полос прокрутки, показывающий, какие полосы прокрутки должны присутствовать в многострочном поле.\ Используется при установленном тэге [``](#multiline). Ожидается одно из допустимых значений, указанных в описании тэга [``](#scroll_bars). ```xml Horizontal ``` ### ScrollToEnd Прокручивает содержимое поля до вертикальных и горизонтальных конечных точек полос прокрутки. Значение не ожидается. ```xml ``` ### BorderStyle Задает тип границы элемента. Ожидается одно из допустимых значений, указанных в описании тэга [``](#border_style). ```xml Fixed3D ```