OnStageChange Event (Client API reference)

This event occurs when the stage of a business process flow control changes. This event occurs when the user clicks the Next Stage or Move to previous stage buttons in the user interface or when a developer uses the formContext.data.process.moveNext or formContext.data.process.movePrevious methods. You can't cancel the stage change using code in a handler for this event.

An execution context object is passed to event handlers for this event. You can use the getEventArgs method to retrieve an object that has the following methods:

• getDirection: Returns a string that is either "next" or "previous" to show the direction of the stage change.
• getStage: Returns a stage object. Except when the navigation moves to a new table, the stage returned represents the destination stage object,that is, the next active stage. When the navigation moves to a new table, the stage is the stage being navigated from, that is, the previous active stage object. More information: Stage methods.

Methods supported for this event

• formContext.data.process.addOnStageChange method to add event handlers for this event.
• formContext.data.process.removeOnStageChange method to remove event handlers for this event.