Click or drag to resize
DocumentChangeOrderEventArgsTDocument Class
Document change order event arguments
Inheritance Hierarchy
SystemObject
  SystemEventArgs
    CMS.BaseCMSEventArgs
      CMS.BaseCMSEventArgsTDocument
        CMS.DocumentEngineDocumentChangeOrderEventArgsTDocument
          CMS.DocumentEngineDocumentChangeOrderEventArgs

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 12.0.0
Syntax
C#
public class DocumentChangeOrderEventArgs<TDocument> : CMSEventArgs<TDocument>

Type Parameters

TDocument

The DocumentChangeOrderEventArgsTDocument type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyNewOrder
Specific new document order index to be set. If not defined, the OrderType is used instead.
Public propertyNode
Document
Public propertyOrderType
Defines the order type (First, Last, Alphabetical) if the NewOrder is not specified.
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyParameter
Event parameter
(Inherited from CMSEventArgsParameterType.)
Public propertyRelativeOrder
Indicates if the NewOrder index is relative to current document position.
Top
Methods
  NameDescription
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.)
Top
See Also