Платформа WT
Синтаксис
База знаний

TextBox

Элемент пользовательского интерфейса для ввода и изменения текста.

Шаблон TextBox

Перечень всех возможных тэгов объекта:

<MyObject Name="" Type="TextBox" Assembly="BaseControls" ChangeForm="">
  <!--Тэги, общие для всех графических объектов-->
  <Top></Top>
  <Bottom></Bottom>
  <Left></Left>
  <Right></Right>
  <Height></Height>
  <Width></Width>
  <FontStyle></FontStyle>
  <ForeColor></ForeColor>
  <BackColor></BackColor>
  <Enabled></Enabled>
  <Visible></Visible>
  <Opacity></Opacity>
  <Hint></Hint>
  <ContextMenu Name="" />
  <Change User="" Source="" ValueSet="" />
  <!--Тэги, специфичные для TextBox-->
  <MaxLength></MaxLength>
  <ReadOnly></ReadOnly>
  <Multiline></Multiline>
  <Password></Password>
  <AllowedSymbols></AllowedSymbols>
  <InputLanguage></InputLanguage>
  <InputCase></InputCase>
  <Mask></Mask>
  <TipText></TipText>
  <TipTextColor></TipTextColor>
  <TextAlign></TextAlign>
  <Text></Text> 
  <Keyboard></Keyboard> 
  <ReturnType></ReturnType> 
  <ReturnCommands></ReturnCommands> 
</MyObject>

Описание TextBox

<MyObject Name="TextBoxName" Type="TextBox" Assembly="BaseControls">
  <!--Тэги, общие для всех графических объектов-->
  <!--Тэги, специфичные для TextBox-->
</MyObject>

Значением TextBox считается текст, указанный в поле.

Получение значения TextBox

Для получения указанного в поле текста используется get-проперти Text:

<Object Name="TextBoxName">
  <Property Name="Text" />
</Object>

Рекомендуется использовать сокращенный вариант записи:

<Object Name="TextBoxName" />

Задание значения TextBox

Для задания значения текстовому полю используется set-проперти Text:

<Object Name="TextBoxName">
  <Property Name="Text">Текст</Property>
</Object>

Рекомендуется использовать сокращенный вариант записи:

<Object Name="TextBoxName">Текст</Object>

Тэги, специфичные для TextBox

MaxLength

Задает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле.

Необязательный тэг. Ожидается положительное целочисленное значение.

По умолчанию используется значение 0, показывающее, что ограничения нет.

<MaxLength>0</MaxLength>

ReadOnly

Указывает, доступно ли текстовое поле только для чтения или для чтения и редактирования.

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

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

<ReadOnly>False</ReadOnly>

Multiline

Задает значение, показывающее, является ли данный элемент управления многострочным текстовым полем. Игнорируется при наличии тэга <Mask>.

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

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

<Multiline>False</Multiline>

Password

Признак, разрешающий ввод пароля. Пользователь увидит только символы звездочек ( * ). Игнорируется при наличии тэга <Mask>.

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

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

<Password>False</Password>

AllowedSymbols

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

Необязательный тэг. Любое значение будет переведено в текстовое.

Если тэг отсутствует, то можно вводить любые символы.

<AllowedSymbols>0123456789</AllowedSymbols>

InputLanguage

Задает ограничение на язык вводимых символов. Если язык вводимого символа не совпадает с языком, указанным в данном тэге, то этот символ будет трансформирован в символ другого языка, расположенный на этой же клавише клавиатуры.

Необязательный тэг. Ожидается одно из допустимых значений:

Rus

Русский язык

Eng

Английский язык

None

Без ограничений по языку

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

<InputLanguage>None</InputLanguage>

Например, при значении Rus вводимая последовательность символов "qwerty" будет преобразована в "йцукен".

InputCase

Задает ограничение на регистр вводимых символов. Если регистр вводимого символа не совпадает с регистром, указанном в данном тэге, то этот символ будет трансформирован в указанный регистр.

Необязательный тэг. Ожидается одно из допустимых значений:

Upper

Верхний регистр

Lower

Нижний регистр

None

Без ограничений по регистру

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

<InputCase>None</InputCase>

Mask

Маска ввода текстового поля.

Пустая строка соответствует отсутствию маски.

Необязательный тэг. Любое значение будет переведено в текстовое.

<Mask>AA-00</Mask>

Поддерживаемые элементы в выражении для задания маски ввода: 0,9,#,L,?,&,C,A,a,\. Их описание смотрите по ссылке.

Для задания маски номера телефона используется служебное слово PHONE, которое переключает текстовое поле в режим ввода номера телефона. При этом маска выбирается автоматически на основе зоны и кода страны. Подробнее по ссылкам здесь и здесь.

<Mask>PHONE</Mask>

TipText

Задает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL.

Необязательный тэг. Любое значение будет переведено в текстовое.

<TipText>Текст подсказки</TipText>

TipTextColor

Цвет текста, который будет расположен в поле, если оно не имеет фокуса и его значение NULL.

Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb).

Если тэг <TipTextColor> отсутствует, то используется цвет по умолчанию заданный в настройках стиля приложения.

<TipTextColor>TipTextColor</TipTextColor>

TextAlign

Используется, чтобы указать способ выравнивания текста по горизонтали. Игнорируется при наличии тэга <Mask>.

Необязательный тэг. Ожидается одно из допустимых значений:

Left

Слева

Center

По центру

Right

Справа

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

<TextAlign>Left</TextAlign>

Text

Задает значение текстового поля.

Необязательный тэг. Любое значение будет переведено в текстовое.

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

<Text>Текст</Text>

Keyboard

Вид клавиатуры при вводе.

Необязательный тэг. Ожидается одно из допустимых значений:

Plain

Клавиатура без флагов, которые определяют регистр букв, проверку орфографии и предложения при вводе

Chat

Клавиатура для чата

Email

Клавиатура для ввода Email

Numeric

Клавиатура ввода числовых значений

Telephone

Клавиатура ввода телефона

Text

Клавиатура ввода текста

Url

Клавиатура ввода ссылки

Default

Клавиатура по умолчанию

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

<Keyboard>Phone</Keyboard>

ReturnType

Вид кнопки завершения ввода у клавиатуры.

Необязательный тэг. Ожидается одно из допустимых значений:

Done

Кнопка "Готово"

Go

Кнопка "Вперед"

Next

Кнопка "Далее"

Search

Кнопка "Поиск"

Send

Кнопка отправки

Default

Кнопка по умолчанию

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

<ReturnType>Search</ReturnType>

ReturnCommands

Список команд, которые будут выполнены последовательно после нажатия на кнопку завершения ввода клавиатуры.

Необязательный тэг.

<ReturnCommands>
  <Command Name="" />
</ReturnCommands>

Get-проперти для получения свойств

MaxLength

Возвращает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле.

<Object Name="TextBoxName">
  <Property Name="MaxLength" />
</Object>

ReadOnly

Возвращает значение, определяющее, доступно ли текстовое поле только для чтения или для чтения и редактирования.

<Object Name="TextBoxName">
  <Property Name="ReadOnly" />
</Object>

Multiline

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

<Object Name="TextBoxName">
  <Property Name="Multiline" />
</Object>

Password

Возвращает значение признака ввода пароля в поле.

<Object Name="TextBoxName">
  <Property Name="Password" />
</Object>

AllowedSymbols

Возвращает набор символов, которые разрешено вводить в поле.

<Object Name="TextBoxName">
  <Property Name="AllowedSymbols" />
</Object>

InputLanguage

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

<Object Name="TextBoxName">
  <Property Name="InputLanguage" />
</Object>

InputCase

Возвращает название регистра, к которому будут преобразовываться вводимые символы.

<Object Name="TextBoxName">
  <Property Name="InputCase" />
</Object>

Mask

Возвращает маску ввода текстового поля.

<Object Name="TextBoxName">
  <Property Name="Mask" />
</Object>

TipText

Возвращает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL.

<Object Name="TextBoxName">
  <Property Name="TipText" />
</Object>

TipTextColor

Возвращает цвет текста, который может быть расположен в объекте, если он не будет иметь фокуса и его значение NULL.

<Object Name="TextBoxName">
  <Property Name="TipTextColor" />
</Object>

TextAlign

Возвращает способ выравнивания текста по горизонтали.

<Object Name="TextBoxName">
  <Property Name="TextAlign" />
</Object>

Text

Возвращает значение текстового поля.

<Object Name="TextBoxName">
  <Property Name="Text" />
</Object>

WordByNumber

Возвращает целое слово с указанным порядковым номером, извлеченное из значения поля. Символами-разделителями между словами считаются " ", ",", ".", ";".

Ожидается целочисленное положительное значение.

<Object Name="TextBoxName">
  <Property Name="WordByNumber">1</Property>
</Object>

Например, для строки "слово1 слово2" свойство со значением 2 вернет "слово2".

Length

Возвращает длину текста, введенного в поле.

<Object Name="TextBoxName">
  <Property Name="Length" />
</Object>

Keyboard

Возвращает название типа клавиатуры.

<Object Name="TextBoxName">
  <Property Name="Keyboard" />
</Object>

ReturnType

Возвращает название типа кнопки возврата клавиатуры.

<Object Name="TextBoxName">
  <Property Name="ReturnType" />
</Object>

Set-проперти для динамического задания свойств

MaxLength

Задает максимальное число символов, которое разрешается вводить или вставлять в текстовое поле.

Ожидается положительное целочисленное значение.

<Object Name="TextBoxName">
  <Property Name="MaxLength">200</Property>
</Object>

ReadOnly

Задает значение, определяющее, доступно ли поле только для чтения или для чтения и редактирования.

Ожидается логическое значение.

<Object Name="TextBoxName">
  <Property Name="ReadOnly">True</Property>
</Object>

Multiline

Задает значение, показывающее, является ли данный элемент управления многострочным текстовым полем. Если тэг <Mask> присутствует в описании объекта, то любое переданное значение игнорируется.

Ожидается логическое значение.

<Object Name="TextBoxName">
  <Property Name="Multiline">True</Property>
</Object>

Password

Задает значение признака ввода пароля в поле. Если тэг <Mask> присутствует в описании объекта, то любое переданное значение игнорируется.

Ожидается логическое значение.

<Object Name="TextBoxName">
  <Property Name="Password">True</Property>
</Object>

AllowedSymbols

Задает набор символов, которые разрешено вводить в поле.

Любое значение будет переведено в текстовое.

<Object Name="TextBoxName">
  <Property Name="AllowedSymbols">0123,.</Property>
</Object>

InputLanguage

Задает правила трансформации языка вводимых символов.

Ожидается одно из допустимых значений, указанных в описании тэга <InputLanguage>.

<Object Name="TextBoxName">
  <Property Name="InputLanguage">Rus</Property>
</Object>

InputCase

Задает название языка, к которому будут преобразовываться вводимые символы.

Ожидается одно из допустимых значений, указанных в описании тэга <InputCase>.

<Object Name="TextBoxName">
  <Property Name="InputCase">Lower</Property>
</Object>

Mask

Задает маску ввода текстового поля.

Любое значение будет переведено в текстовое. Полные правила указания маски ввода указаны в описании тэга <Mask>.

<Object Name="TextBoxName">
  <Property Name="Mask">###.##</Property>
</Object>

TipText

Задает текст-заполнитель, который будет отображаться в поле, если оно не имеет фокуса и его значение NULL.

Любое значение будет переведено в текстовое.

<Object Name="TextBoxName">
  <Property Name="TipText">Текст</Property>
</Object>

TipTextColor

Задает цвет текста, который может быть расположен в объекте, если он не будет иметь фокуса и его значение NULL.

Ожидается название одного из цветов, объявленных на форме.

<Object Name="TextBoxName">
  <Property Name="TipTextColor">TipTextColor</Property>
</Object>

TextAlign

Задает способ выравнивания текста по горизонтали.

Ожидается одно из допустимых значений, указанных в описании тэга <TextAlign>.

<Object Name="LabelName">
  <Property Name="TextAlign">Right</Property>
</Object>

Text

Задает значение текстового поля.

Любое значение будет переведено в текстовое.

<Object Name="TextBoxName">
  <Property Name="Text">Текст</Property>
</Object>

AppendText

Дописывает поле заданным текстом и переводит курсор в конец поля.

Любое значение будет переведено в текстовое.

<Object Name="TextBoxName">
  <Property Name="AppendText">Текст</Property>
</Object>

Keyboard

Задает тип клавиатуры.

Ожидается одно из названий типов клавиатуры, описанных в тэге <Keyboard>.

<Object Name="TextBoxName">
  <Property Name="Keyboard">Phone</Property>
</Object>

ReturnType

Задает тип кнопки возврата клавиатуры.

Ожидается одно из названий типов кнопки возврата клавиатуры, описанных в теге <ReturnType>.

<Object Name="TextBoxName">
  <Property Name="ReturnType">Search</Property>
</Object>

InsertAtCursorPosition

Вставляет заданный текст на место курсора и после переводит курсор в конец добавленного текста. Если поле не содержит фокуса, то тогда вставляемый текст добавляется в конец строки, и поле получает фокус.

Любое значение будет переведено в текстовое.

<Object Name="TextBoxName">
  <Property Name="InsertAtCursorPosition">Текст</Property>
</Object>

Last updated