Text Field
Text Field is a component that allows editing a single line of text. |
|
Here is what a text field looks like:
Common Properties
Width, Height, Bindings, Enabled, Visible, Foreground, Background, Opaque, Border, Font, Cursor, Tooltip, Focusable, Popup Menu
Custom Properties
Text
Default text in the text field.
Property name: text
Property type: String
Editable
This flag indicates that text in the text field can be changed. The primary difference between non-editable and non-enabled components is that text in a non-editable component is not grayed out and may be selected using the mouse.
Property name: editable
Property type: Boolean
Onscreen Keyboard
Defines whether this component should support onscreen keyboard for text input. See touchscreen support for details.
Possible choices are:
- None - don't use onscreen keyboard
- Single Click - show the keyboard upon any click in the component area
- Double Click - show the keyboard only if component is double-clicked
Property name: onscreenKeyboard
Property type: Integer
Alignment
Horizontal alignment of text within label display area.
Possible values:
Description | Value |
Left | 2 |
Center | 0 |
Right | 4 |
Property name: horizontalAlignment
Property type: Integer
Common Events
Hidden, Shown, Moved, Resized, Mouse Clicked, Mouse Pressed, Mouse Released, Mouse Entered, Mouse Exited, Mouse Moved, Mouse Wheel Moved, Key Typed, Key Pressed, Key Released, Focus Gained, Focus Lost
Custom Events
Caret Update
This event fires each time when a caret is moved or any text is entered in the component.
Event name: caretUpdate
Event fields:
Field | Name | Type | Description |
ID | id | Integer | Event type ID. |
Dot | dot | Integer | The location of the caret. |
Mark | mark | Integer | The location of other end of a logical selection. If there is no selection, this will be the same as dot. |
Was this page helpful?