OnStageSelected event (Client API reference)

This event occurs when a stage of a business process flow control is selected. You can't cancel the stage selection using code in a handler for this event.

Note

The chevron arrow buttons in the business process flow bar can be used to move through and view all the stages. However, these forward and backward chevron buttons do not select the stage and do not change the active stage. Therefore, OnStageSelected event does not occur while navigating and viewing stages when using the chevron arrow buttons.

You can use the getEventArgs method to retrieve an object that has the following method:

getStage: Returns a stage object representing the selected stage. More information: Stage methods.

Methods supported for this event

• formContext.data.process.addOnStageSelected method to add event handlers for this event.
• formContext.data.process.removeOnStageSelected method to remove event handlers for this event.