Text Area

Top  Previous  Next

A Text Area is a component that displays multiple editable lines of text.

gb_component_textarea

This is what a text area looks like:

ls_widgets_text_area

Common Properties

Width, Height, Bindings, Enabled, Visible, Foreground, Background, Opaque, Border, Font, Tooltip

Custom Properties

Text (Default Property)

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.

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