WorkflowEventArgs Class

Workflow event arguments

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.DocumentEngine.WorkflowEventArgs

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 11.0.0

Syntax

public class WorkflowEventArgs : CMSEventArgs

The WorkflowEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	WorkflowEventArgs

Properties

	Name	Description
Public property	Attachment	Document attachment, used where it makes sense: Save attachment version
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	Document	Edited version of the document
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	PreviousStep	Previous workflow step, used where it makes sense: After approve, After reject, After archive
Public property	PublishedDocument	Published version of the document, available only for Published handler in after event
Public property	TreeProvider	Tree provider
Public property	VersionComment	Version comment, used where it makes sense: Save version
Public property	VersionHistory	Version history info record, used where it makes sense: Save version
Public property	VersionNumber	Version number, used where it makes sense: Save version

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from CMSEventArgs.)
Public method	CallWhenFinished	Adds the given action to be called when the handler finishes (Inherited from CMSEventArgs.)
Public method	Cancel	Cancels the current handler execution (Inherited from CMSEventArgs.)
Public method	DetectRecursion	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 method	Dispose	Make sure the objects get disposed (Inherited from CMSEventArgs.)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)

Extension Methods

	Name	Description
Public Extension Method	UseTransaction	Ensures that the event uses transaction (Defined by DataExtensions.)