Text Area
A Text Area is a component that displays multiple editable lines of text. |
|
This is what a text area looks like:
Common Properties
Width, Height, Bindings, Enabled, Visible, Foreground, Background, Opaque, Border, Font, Cursor, Tooltip, Focusable, Popup Menu
 | To enable scrolling, the Text Area must be placed on the Panel with the necessary scrolling settings and the Width and Height of the Text Area must be set to zero. |
Custom Properties
Text
Default text contained in the text area.
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
Line Wrap
Sets the line-wrapping policy of the text area. If enabled, lines will be wrapped if they are too long to fit the allocated width. If disabled, the lines will always be unwrapped.
Property name: lineWrap
Property type: Boolean
Wrap on Word Bounds
Sets the style of wrapping used if line wrap is enabled. If enabled, the lines will be wrapped at word boundaries (whitespace) if they are too long to fit within the allocated width. If disabled, the lines will be wrapped at character boundaries (i.e, broken mid-word).
Property name: wrapStyleWord
Property type: Boolean
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?