Skip to main content
Version: 8.1

Vision - Text Area

Component Palette Icon

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.

Properties

PropertyDescriptionProperty TypeScriptingCategory
Background ColorThe background color of the component.Color.backgroundAppearance
BorderThe border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Field Border, and Line Border.
Note: The border is unaffected by rotation.

Changed in 8.1.21
As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
ColumnsThe number of columns you expect to display (used as a hint for scrollbars).int.columnsAppearance
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
Defer UpdatesWhen true, the 'text' property will not fire updates while typing. It will wait for the component to lose focus.boolean.deferUpdatesBehavior
EditableControls whether or not the user can edit the text within this text area. When the option is not selected, the text is not editable in the client and the background of the component will be grey.boolean.editableBehavior
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component.Color.foregroundAppearance
Line WrapShould this area wrap lines?boolean.lineWrapBehavior
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Reject Updates During EditIf true, this field will not accept updates from external sources (like DB bindings) while the user is editing the field.boolean.rejectUpdatesDuringEditBehavior
RowsThe number of rows you expect to display (used as a hint for scrollbars).int.rowsAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Tab SizeThis adjusts the default size of tab characters.int.tabSizeAppearance
TextText of this component.String.textData
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
Touchscreen Keyboard Layout
New in 8.1.28
Sets the touchscreen keyboard layout to use for this component.
String.keyboardNameBehavior
VisibleIf disabled, the component will be hidden.boolean.visibleCommon

Deprecated Properties

PropertyDescriptionProperty TypeScriptingCategory
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated

Scripting

Component Functions

This component does not have component functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page

Customizers

Examples

Word Wrap and No Scroll Bars until Needed

Property NameValue
Line WrapTrue
Text468 Characters
Rows0
Columns0