DocumentEventArgs Class

Document event arguments

Inheritance Hierarchy

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

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

Syntax

public class DocumentEventArgs : CMSEventArgs

The DocumentEventArgs type exposes the following members.

Constructors

	Name	Description
Public method	DocumentEventArgs

Properties

	Name	Description
Public property	Attachment	Attachment, where is makes sense: SaveAttachment, DeleteAttachment
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	IncludeChildren	If true the children are included within the operation where it makes sense: Copy
Public property	Node	Document node
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	TargetParentNode	Target parent node, initialized for operations where it makes sense: Copy, Move, Insert
Public property	TargetParentNodeID	Target parent node ID, initialized for operations where it makes sense: Copy, Move, Insert
Public property	TreeProvider	Tree provider

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.)