DocumentChangeOrderEventArgs<TDocument> Class

Document change order event arguments

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.Base.CMSEventArgs<TDocument>
        CMS.DocumentEngine.DocumentChangeOrderEventArgs<TDocument>
          CMS.DocumentEngine.DocumentChangeOrderEventArgs

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

Syntax

public class DocumentChangeOrderEventArgs<TDocument> : CMSEventArgs<TDocument>

Type Parameters

TDocument

The DocumentChangeOrderEventArgs<TDocument> type exposes the following members.

Constructors

	Name	Description
Public method	DocumentChangeOrderEventArgs<TDocument>()	Constructor.
Public method	DocumentChangeOrderEventArgs<TDocument>(TDocument, DocumentOrderEnum)	Constructor.
Public method	DocumentChangeOrderEventArgs<TDocument>(TDocument, Int32, Boolean)	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	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	NewOrder	Specific new document order index to be set. If not defined, the OrderType is used instead.
Public property	Node	Document
Public property	OrderType	Defines the order type (First, Last, Alphabetical) if the NewOrder is not specified.
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	Parameter	Event parameter (Inherited from CMSEventArgs<ParameterType>.)
Public property	RelativeOrder	Indicates if the NewOrder index is relative to current document position.