Click or drag to resize
DocumentManagerEventArgs Class
Manager event arguments
Inheritance Hierarchy

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 9.0.0
public class DocumentManagerEventArgs : SimpleDocumentManagerEventArgs

The DocumentManagerEventArgs type exposes the following members.

Public methodDocumentManagerEventArgs
Public propertyActionName
Action name. For general events (DATA_SAVED, LOAD_DATA...)
(Inherited from SimpleManagerEventArgs.)
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyCurrentStep
Current document workflow step
Public propertyErrorMessage
Error message in case action is not valid
(Inherited from SimpleManagerEventArgs.)
Public propertyCheckDefault
Indicates if default check should be performed
(Inherited from SimpleManagerEventArgs.)
Public propertyIsValid
Indicates if the action is valid
(Inherited from SimpleManagerEventArgs.)
Public propertyMode
Mode of the manager (Insert, Update, New language version)
(Inherited from ManagerEventArgs.)
Public propertyNode
Document node
(Inherited from SimpleDocumentManagerEventArgs.)
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyOriginalStep
Original document workflow step
Public propertySaveActionContext
Context of the save action. When the document was saved as a part of another action.
Public propertyUpdateDocument
Indicates if the document should be updated after save data event
Public propertyUseDocumentHelper
Indicates if DocumentHelper should be used to manage the document (Use FALSE if modifying non-versioned properties.)
Public propertyWorkflow
Document workflow
Public propertyWorkflowFinished
Indicates if workflow was finished (There is no more workflow applied for the document.)
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.)
Extension Methods
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
See Also