Text Box

Used to input or edit a single line of text.

Properties

PropertyDescription
EnabledBoolean indicating whether or not the component is enabled.
HintSpecifies the user hint string that will appear in the component's interactive help bubble.
InputTypeInput type, "auto" by default (Qubes 5.4).
MaxLengthInteger indicating the maximum length of a text in UTF-16 characters (Qubes5.6).
PlaceholderA placeholder text visible when the component is empty, to hint about its purpose (Qubes 10.0)
TabIndexInteger indicating the component's tab order (Qubes 5.6).
ValueInitialDetermines the component's initial value when the screen opens and each time it is reset (see Reset Button).
VisibleBoolean indicating whether or not the component will be visible.

Value

The value of a text box is the text that is actually present in the box.

The InputType property defines how the input value will be interpreted:

  • auto: if the input resembles a number, the result will be numerical; if not, it will be a string;
  • string: the input is a string, even if its content is numerical;
  • numeric: the input is numerical; if the content is empty or is not a number, the value will be NaN (Qubes 6.7) or 0 in earlier versions.
  • password: the input is a string whose characters are hidden (Qubes 6.7).
  • barcode: the input is a string, where character GS is allowed (Qubes 11.0).

Remarks

If you want to allow multiple lines of text to be input or edited, or if you want to have scroll bars, use a multi-line text field component.

auto will recognize numers in formats compatible with the JavaScript formats.

Classification

Standards