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.
| Name | Description | Property Type |
|---|---|---|
| text | Text to display. | value: string |
| placeholder | Text displayed when Text Area is empty. | value: string |
| enabled | If true, user is allowed to alter text. | value: boolean |
| deferUpdates | When true, updates to props.text will be deferred until focus is lost or enter is pressed. | value: boolean |
| rejectUpdatesWhileFocused | When true, props.text will not accept updates from external sources while focused. | value: boolean |
| resize | Sets whether text is resizable, and if so, in which direction: none, both, horizontal, or vertical. | value: string |
| wrap | Specifies 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 |
| style | Sets 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 | 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 Scripts and Events​
Further component interaction and functionality can be configured for all components through scripting and event actions. Right-click on the component or select Components from the Designer menubar to access the configuration popups for both of these options:
- Configure Events: Accesses the Event Configuration popup where you can configure actions to run in response to events to make the component dynamic. The Events Configurations page shows how to configure events and actions on a Perspective component.
- Configure Scripts: Accesses the Script Configuration popup where custom methods and message handlers can be added. The Scripting in Perspective section details scripting fundamentals, creating custom methods, and using message handlers.
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.
| Property | Value |
|---|---|
| props.text | Data 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.placeholder | Lab Data Entry |
| props.wrap | off |