The WorkflowEventArgs type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
WorkflowEventArgs |
Methods
Name | Description | |
---|---|---|
CallOnDispose |
Adds the given action to the list of actions called when the handler object is disposed
(Inherited from CMSEventArgs.) | |
CallWhenFinished |
Adds the given action to be called when the handler finishes
(Inherited from CMSEventArgs.) | |
Cancel |
Cancels the current handler execution
(Inherited from CMSEventArgs.) | |
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.) | |
Dispose |
Make sure the objects get disposed
(Inherited from CMSEventArgs.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Lock |
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
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 | |
---|---|---|
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) | |
UseTransaction |
Ensures that the event uses transaction
(Defined by DataExtensions.) |
Fields
Name | Description | |
---|---|---|
mCallWhenFinished |
List of actions to be called when the event finishes
(Inherited from CMSEventArgs.) |
Properties
Name | Description | |
---|---|---|
Attachment |
Document attachment, used where it makes sense: Save attachment version
| |
CurrentHandler |
Currently executing handler
(Inherited from CMSEventArgs.) | |
Document |
Edited version of the document
| |
OriginalEventArgs |
Original event arguments for the event
(Inherited from CMSEventArgs.) | |
PreviousStep |
Previous workflow step, used where it makes sense: After approve, After reject, After archive
| |
PublishedDocument |
Published version of the document, available only for Published handler in after event
| |
TreeProvider |
Tree provider
| |
VersionComment |
Version comment, used where it makes sense: Save version
| |
VersionHistory |
Version history info record, used where it makes sense: Save version
| |
VersionNumber |
Version number, used where it makes sense: Save version
|
See Also