OnBeforeEventArguments
The OnBeforeEventArguments class represents the arguments passed to an event handler executed before an event in the workflow. It extends OnEventArguments and adds the Cancel property to allow cancelling the event.
Properties
| Name | Description |
|---|---|
| EventCode | The event code of the event. |
| IsSessionStarterObject | Gets whether this execution is for a session starter object. |
| Reason | A dictionary containing the reason for the action taken. |
| Cancel | Gets or sets a value indicating whether the event should be cancelled. If true, the event will be cancelled. |
| Step | Gets the arguments containing information about the current workflow step. |
| ResultEventCode | The result event code after the event has been processed. |
| ActionerType | The ApproverType enum represents the various types of approvers in a workflow process, indicating how approval is handled. |
| Context | Gets the business context in which the workflow step is being executed. |
| ActionerUserId | The ID of the user who performed the action. |
| ProcessId | Gets the unique identifier of the workflow process instance. |
Constructors
| Name | Description |
|---|---|
| OnBeforeEventArguments(eventCode, resultEventCode, actionerUserId, actionerType, reason, step, processId, isSessionStarterObject, context) | Constructor for the OnBeforeEventArguments class. Initializes a new instance of OnBeforeEventArguments with the specified parameters. |
| OnBeforeEventArguments(eventCode, resultEventCode, actionerUserId, actionerType, reason, step, processId, isSessionStarterObject, context) | Constructor for the OnBeforeEventArguments class. Initializes a new instance of OnBeforeEventArguments with the specified parameters. |
| OnBeforeEventArguments(step, processId, isSessionStarterObject, context) | Initializes a new instance of the OnBeforeEventArguments class with complete workflow execution information. |