Click or drag to resize
WorkflowActionEventArgsInfoType, StateInfoType, ActionEnumType Class
Workflow action event arguments
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.WorkflowEngineWorkflowActionEventArgsInfoType, StateInfoType, ActionEnumType

Namespace: CMS.WorkflowEngine
Assembly: CMS.WorkflowEngine (in CMS.WorkflowEngine.dll) Version: 11.0.0
Syntax
C#
public class WorkflowActionEventArgs<InfoType, StateInfoType, ActionEnumType> : CMSEventArgs, 
	IWorkflowActionEventArgs
where InfoType : BaseInfo
where StateInfoType : BaseInfo
where ActionEnumType : struct, new(), IConvertible

Type Parameters

InfoType
StateInfoType
ActionEnumType

The WorkflowActionEventArgsInfoType, StateInfoType, ActionEnumType type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyActionDefinition
Action definition.
Public propertyActionStep
Current step.
Public propertyComment
Comment used when action moves to next step.
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyInfoObject
Current info object.
Public propertyInitialStep
Current step.
Public propertyManager
Manager.
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyOriginalStep
Current step.
Public propertyParameters
Parameters of action.
Public propertyStateObject
Info object representing automation state. Used for automation processes.
Public propertyStopProcessing
Indicates if the process should be stopped. Process is not moved to the next step.
Public propertyUser
User running action.
Public propertyWorkflow
Current workflow.
Top
Methods
  NameDescription
Public methodCallOnDispose
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.)
Public methodCallWhenFinished
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.)
Public methodCancel
Cancels the current handler execution
(Inherited from CMSEventArgs.)
Public methodDetectRecursion
Prevents the recursion of the handler execution using the given unique key. The handler won't execute again with the given key until the current execution is finished. Returns true, if recursion is detected and the code shouldn't continue. Otherwise returns false.
(Inherited from CMSEventArgs.)
Public methodDispose
Make sure the objects get disposed
(Inherited from CMSEventArgs.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Top
Extension Methods
  NameDescription
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Top
See Also