Text Editor control

This control creates a text editor area that provides font and paragraph formatting settings for the input text.

Data binding

Set or modify the data binding for the control in the General properties tab. The Text Editor control can be bound to a String variable.

Configuration properties

Set or modify configuration properties for the control, such as appearance and behavior properties, in the Configuration properties tab.

Screen size: A configuration property that has the Screen Sizes icon beside the property name can have different values for each screen size. If you do not set a value, the screen size inherits the value of the next larger screen size as its default value. If you are using the Process Designer desktop editor, you are setting the value for the large screen size. The other screen sizes inherit this value.

Theme definitions: Theme definitions specify the colors and styles for a control and determine the appearance of the control. You can preview the look and feel of controls in the theme editor. See Themes.

The appearance configuration properties for the Text Editor control are shown in the following table:

Table 1. Appearance configuration properties for the Text Editor control
Appearance configuration property	Description	Data type
Width	Specifies the width of the text area in `px` (pixels), `%` (percent), or `em` units. For example: `50px` or `20%` or `0.4em`. If no unit type is specified, `px` is assumed.	`String`
Height	Specifies the height of the text field in `px` (pixels) or `em` units. If no unit type is specified, `px` is assumed.	`String`

The behavior configuration properties for the Text Editor control are listed in the following table:

Table 2. Behavior configuration properties for the Text Editor control
Behavior configuration property	Description	Data type
Tab index	Specifies the tabbing sequence index of the control. The tab indices start at 1 and can be set sparsely. For example, you can use 1, 5, 10. The Tab index property controls the tabbing sequence when you move between coach areas by pressing the Tab key.	`Integer`
Palette colors	The default colors that are available in the text color palette. The number of colors is determined by the number of rows and columns. `Name`: The name of the color is displayed as a tooltip at mouse-over. `Value`: The hexadecimal representation of the specified color.	`NameValuePair[]`
Palette columns	The number of columns for the text color palette. The default number is 8.	`Integer`
Palette rows	The number of rows for the text color palette. The default number is 5.	`Integer`
Show status bar	Shows or hides the status bar underneath the editor area. The status bar displays the HTML element that is currently edited.	`Boolean`

Events

Set or modify the event handlers for the control in the Events tab. You can set events to be triggered programmatically or when a user interacts with the control. For information about how to define and code events, see User-defined events.

The Text Editor control has the following types of event handlers:

On load: Activated when the page loads. For example:
```
me.setText("Some default text on load.")
```

On change: Activated when the text is changed. For example:

if(newText != oldText){return confirm ("Are you sure you want to change the text area field?");}

On focus: Activated when the focus moves to the text field. For example:
```
me.setLabelPlacement("T")
```
On blur: Activated when the text field loses the focus. For example:
```
me.setLabelPlacement("L")
```
On input: Activated when the user enters text in the text field. For example:
```
return potential.length<=10;
```

Methods

For detailed information on the available methods for the Text Editor control, see the JavaScript documentation.

Additional resources

For information about how to create a coach, see Building coaches.
For information about standard properties (General, Configuration, Positioning, Visibility, and HTML Attributes), see Coach view properties.