Skip to end of metadata
Go to start of metadata

Component Palette Icon:

On this page ...

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

NameDescriptionProperty TypeScriptingCategory
Background ColorThe background color of the component.Color.backgroundAppearance
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

Note: The border is unaffected by rotation.

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
Editable

Controls 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
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
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. 

Examples

Word Wrap and no Scroll Bars until they are needed

Property NameValue
Line WrapTrue
Text468 Characters
Rows0
Columns0
  • No labels