Modal Section

Modal Section is a basic container coach view that you can use to enable users to create a container that displays modally. That is, users cannot continue to work on the main window before this container is dismissed.

A Modal Section is not an alert. Rather, it serves as a separate section from the main interface for the user to handle a tangent task or display something, which precludes the user from working on other parts of the user interface.

Typically, a Modal Section uses a layout of other controls, such as Well or Panel.

Tip: You must set the visibility property of the Modal Section control to None (under Properties > Visibility), otherwise the Modal Section shows by default.

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 (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 Modal Section control are shown in the following table:

Table 1. Appearance configuration properties for Modal Section
Appearance configuration property	Description	Data type
Modal placeholder width	Specifies the width of the control in pixels (px), percentage of the original width (%), or em units.	`String`

The behavior configuration properties for the Modal Section control are shown in the following table:

Table 2. Behavior configuration properties for Modal Section
Behavior configuration property	Description	Data type
Close on click	If you select Close on click, users can close the modal section by clicking anywhere outside of it. By default, the modal section cannot be dismissed.	`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.

For the Modal Section control, you can activate the following types of event handlers:

On load. Activated when the page loads, for example me.setVisible(true);
On close.Activated when the Modal Section window is closed, for example ${Output_Text1}.setText("Modal Section closed...");, where Output_Text1 is the control ID of the output text.
On show. Activated when the Modal Section window is opened, for example me.setText("Modal Section is open...");

Methods

For more information about the available methods, see the Modal Section 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.