Status Box control

This control displays a message about the status of other controls in the coach, and is commonly used in conjunction with input controls. Typically, the status box is attached to a form or input control.

Configuration properties

Set or modify configuration properties for the Status Box control, such as appearance and behavior properties, 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, 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 Status Box control are listed in the following table:

Table 1. Appearance configuration properties for the Status Box control
Appearance configuration property	Description	Data type
Width	Specifies the width of the status box in `px` (pixels), `%` (percent), or `em` units. For example, `50px`, `20%`, or `0.4em`. If no unit type is specified, then `px` is assumed.	`String`
Color style	Specifies a color style for the control. The colors correspond to variables in the specified theme.	`String`
Status style	Specifies the shading style based on the color style that you selected: None (light) Default (light) Dark (dark) Simple (no shade)	`String`
Float status	Specifies whether the status box is floating or fixed. If Float status is clear, the status bar moves other elements out of its way.	`Boolean`

The behavior configuration properties for the Status Box control are listed in the following table:

Table 2. Behavior configuration properties for the Status Box control
Behavior configuration property	Description	Data type
Show status	Specifies whether the status box is displayed when the page is loaded.	`Boolean`
Show validation errors	Specifies whether the status includes validation errors.	`Boolean`
Status as HTML	Specifies whether the status includes HTML.	`Boolean`

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 Status Box control are listed in the following table:

Table 3. Formula configuration properties for the Status Box control
Formula configuration property	Description	Data type
Text expression	Provides the expression or formula that calculates the text in the Status Box control. You can set the text either by using a static `string` or dynamically by using a formula. For more information about using formulas, see Binding data and configuration options.	`String`

The Status Box control has the following types of event handlers:

On load: Activated when the page loads. For example:

me.setStatusText("Status Text is Loaded"); me.setStatusVisible(true);

On click: Activated when the status box is clicked. For example:
```
me.setStatusVisible(false);
```

Methods

For detailed information on the available methods for the Status Box 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.