DocumentManagerEventArgs Class

Manager event arguments

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.ExtendedControls.SimpleManagerEventArgs
        CMS.ExtendedControls.ManagerEventArgs
          CMS.ExtendedControls.SimpleDocumentManagerEventArgs
            CMS.ExtendedControls.DocumentManagerEventArgs

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 8.2.23

Syntax

public class DocumentManagerEventArgs : SimpleDocumentManagerEventArgs

The DocumentManagerEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	DocumentManagerEventArgs	Constructor

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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	UseTransaction	Ensures that the event uses transaction (Defined by DataExtensions.)

Fields

	Name	Description
Protected field	mCallWhenFinished	List of actions to be called when the event finishes (Inherited from CMSEventArgs.)

Properties

	Name	Description
Public property	ActionName	Action name. For general events (DATA_SAVED, LOAD_DATA...) (Inherited from SimpleManagerEventArgs.)
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	CurrentStep	Current document workflow step
Public property	ErrorMessage	Error message in case action is not valid (Inherited from SimpleManagerEventArgs.)
Public property	CheckDefault	Indicates if default check should be performed (Inherited from SimpleManagerEventArgs.)
Public property	IsValid	Indicates if the action is valid (Inherited from SimpleManagerEventArgs.)
Public property	Mode	Mode of the manager (Insert, Update, New language version) (Inherited from ManagerEventArgs.)
Public property	Node	Document node (Inherited from SimpleDocumentManagerEventArgs.)
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	OriginalStep	Original document workflow step
Public property	SaveActionContext	Context of the save action. When the document was saved as a part of another action.
Public property	UpdateDocument	Indicates if the document should be updated after save data event
Public property	UseDocumentHelper	Indicates if DocumentHelper should be used to manage the document (Use FALSE if modifying non-versioned properties.)
Public property	Workflow	Document workflow
Public property	WorkflowFinished	Indicates if workflow was finished (There is no more workflow applied for the document.)