Text Area

Suitable for multi-line text display and editing. Will scroll vertically on demand. Will scroll horizontally if line wrap is off. Only supports plain-text, no HTML formatting or styled text.

Appearance

Font

Font of text of this component

Scripting name	font
Data type	Font

Foreground Color

The foreground color of the component.

Scripting name	foreground
Data type	Color

Background Color

The background color of the component.

Scripting name	background
Data type	Color

Rows

The number of rows you expect to display (used as a hint for scrollbars).

Scripting name	rows
Data type	int

Columns

The number of columns you expect to display (used as a hint for scrollbars).

Scripting name	columns
Data type	int

Antialias

Draw with antialias on? Makes text smoother

Scripting name	antialias
Data type	boolean
Flags	expert

Styles

Contains the component's styles

Scripting name	styles
Data type	Dataset
Flags	bindable \| expert

Behavior

Editable

Controls whether or not the user can edit the text within this text area.

Scripting name	editable
Data type	boolean

Defer Updates

When true, the 'text' property will not fire updates while typing.
It will wait for the component to lose focus.

Scripting name	deferUpdates
Data type	boolean

Reject Updates During Edit

If true, this field will not accept updates from external sources (like DB bindings)
while the user is editing the field.

Scripting name	rejectUpdatesDuringEdit
Data type	boolean
Flags	expert

Line Wrap

Should this area wrap lines?

Scripting name	lineWrap
Data type	boolean

Touchscreen Mode

Controls when this input component responds if touchscreen mode is enabled.

Scripting name

touchscreenMode

Data type

int

Flags

expert

Values

0	None
1	Single-Click
2	Double-Click

Common

Name

The name of this component.

Scripting name	name
Data type	String
Flags	bindable

Enabled

If disabled, a component cannot be used.

Scripting name	componentEnabled
Data type	boolean

Visible

If disabled, the component will be hidden.

Scripting name	visible
Data type	boolean
Flags	bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name	border
Data type	Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name	toolTipText
Data type	String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0	Default
1	Crosshair
2	Text
3	Wait
12	Hand
13	Move
4	SW Resize
5	SE Resize
6	NW Resize
7	NE Resize
8	N Resize
9	S Resize
10	W Resize
11	E Resize

Data

Text

Text of this component

Scripting name	text
Data type	String
Flags	bindable

Data Quality

The data quality code for any tag bindings on this component.

Scripting name	dataQuality
Data type	int
Flags	bindable \| expert

The following event sets are fired by this component. See Component Event Handlers to learn more.