Skip to main content
Version: 8.1

Perspective - Text Area

Component Palette Icon:

Description

Suitable for multi-line text display and editing. Will scroll vertically on demand. Horizontal scroll is determined by the "wrap" property.

Properties

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective. This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

NameDescriptionProperty Type
textText to display.value: string
placeholderText displayed when Text Area is empty.value: string
enabledIf true, user is allowed to alter text.value: boolean
deferUpdatesWhen true, updates to props.text will be deferred until focus is lost or enter is pressed.value: boolean
rejectUpdatesWhileFocusedWhen true, props.text will not accept updates from external sources while focused.value: boolean
resizeSets whether text is resizable, and if so, in which direction: none, both, horizontal, or vertical.value: string
wrapSpecifies how to wrap text: hard, soft, or off. (Soft wrap is the break resulting from a line wrap or word wrap. Hard wrap is an intentional break, which moves text to the next line, or creates a new paragraph).value: string
styleSets a style for this component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.object
spellcheck
New in 8.1.27
When true, text containing potential spelling errors will be underlined in red while the text is being edited in a launched session. Be aware there may be some slight behavioral differences in spellcheck error detection depending on the session browser.
value: boolean

Component Events

The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.

Example

This example shows the Text Area in two states: the top image is with text entered and the bottom image is without text entered.

PropertyValue
props.textData Point 01: xy4, zBeta 3
Data Point 02: xy12, zBeta 45
Notes: Example of how a longer sentence can wrap (or not) around to the next line. Enter was pressed between each of these three lines.
props.placeholderLab Data Entry
props.wrapoff