Click or drag to resize
WorkflowEventArgs Class
Workflow event arguments
Inheritance Hierarchy

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 11.0.0
Syntax
C#
public class WorkflowEventArgs : CMSEventArgs

The WorkflowEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodWorkflowEventArgs
Top
Properties
  NameDescription
Public propertyAttachment
Document attachment, used where it makes sense: Save attachment version
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyDocument
Edited version of the document
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyPreviousStep
Previous workflow step, used where it makes sense: After approve, After reject, After archive
Public propertyPublishedDocument
Published version of the document, available only for Published handler in after event
Public propertyTreeProvider
Tree provider
Public propertyVersionComment
Version comment, used where it makes sense: Save version
Public propertyVersionHistory
Version history info record, used where it makes sense: Save version
Public propertyVersionNumber
Version number, used where it makes sense: Save version
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