addOnPreStageChange (Client API reference)

Adds a function as an event handler for the OnPreStageChange event so that it will be called before the business process flow stage changes.

Syntax

formContext.data.process.addOnPreStageChange(myFunction);

Parameter

Name Type Required Description
myFunction Function reference Yes The function that runs before the business process flow stage changes. The function will be added to the start of the event handler pipeline. The execution context is automatically passed as the first parameter to the function. See Execution context for more information.

You should use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.

This client API is only supported on the Unified Client. The legacy web client does not support this client API.

addOnStageChange
removeOnStageChange
formContext.data.process