Note

Note displays read-only text, with various Header options for the label.

The Note control is most commonly used to draw attention to a specific area on a coach, or to display helpful information.

Data binding

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

Configuration properties

Set or modify the appearance configuration properties for the control in the Configuration properties tab. Set the formula configuration properties in the Events 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 (deprecated), 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 Note control are shown in the following table:

Table 1. Appearance configuration properties for Note
Appearance configuration property	Description	Data type
Width	Specifies the width of a note in pixels, percent, or em units. For example: `50px` or `20%` or `0.4em`. The default unit is pixel, in case no other is specified.	`String`
Label style	Specifies the header style for the note label. Default Heading 1 Heading 2 Heading 3	`String`
Color style	Specifies a color style for the control. The colors correspond to variables in the specified theme. The default color style is Default (gray).	`String`

Example

In this example, the following appearance configuration properties are set for the Note control:

Text formula is set to "Read this note".
Label style is set to Heading 1.
Color style is set to Info.

In the General properties tab, the name given to the Label is Note.

These properties and their values result in a text area on a blue background that displays a blue level 1 header labeled Note, followed by the message: Read this note.

Events

Set or modify the formula configuration properties and 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 on how to define and code events, see User-defined events.

The formula configuration properties for the Note control are shown in the following table:

Table 2. Formula configuration properties for Note
Formula configuration property	Description	Data type
Text formula	Formula or expression used to calculate the note text. For more information about formulas, see Formulas.	`String`

The Note control has the following types of event handlers:

On load: Activated when the page loads.
On click: Activated when a note is clicked.

Methods

For detailed information on the available methods for Note, see the Note JavaScript API.

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.