Navigation Event control

With this control, you can handle page navigation with commands instead of buttons.

The Navigation Event control cannot be used by itself. It must be used in combination with other controls.

Configuration properties

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

The behavior configuration properties for the Navigation Event control are shown in the following table:

Table 1. Behavior configuration properties for the Navigation Event control
Behavior configuration property	Description	Data type
Event data	Data to pass into the navigation event.	`String(list)`

Example

In this example, the Navigation Event control is used with two Text controls inside Panel sections.

The Text controls use the fire and confirmAndFire methods to control the Navigation Event:

The On change event handler of the first Text control is set to if(me.getText() = = "EXIT") ${NavigationEvent1}.fire().
The On change event handler of the second Text control is set to if(me.getText() = = "EXIT") ${NavigationEvent1}.confirmAndFire("Are you sure you want to exit?").

As a result:

Typing Exit in the first text box ends the service.
Typing Exit in the second text box returns an alert because of the confirmAndFire method.

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 Navigation Event control has the following types of event handlers:

On load: Activated when the page loads.
On trigger: Activated when a Trigger event is fired, but if this Trigger event explicitly returns false, the On trigger event will not be fired.
On boundary: Activated when there is a Boundary event. If the Boundary event ends with a Stay-on-page event, the On boundary event is not fired until all asynchronous processes associated with the Boundary event are complete.

Depending on the specific event, you can use JavaScript logic to modify the effects of the control. More information on using events with controls is found in the topic Event Handling.

Methods

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