DocumentChangeOrderEventArgs MembersKentico 8.1 API Reference
The DocumentChangeOrderEventArgs type exposes the following members.
Constructors

  NameDescription
Public methodDocumentChangeOrderEventArgs 
Constructor.
Public methodDocumentChangeOrderEventArgs(TreeNode, DocumentOrderEnum)
Constructor.
Public methodDocumentChangeOrderEventArgs(TreeNode, Int32, Boolean)
Constructor.
Back to 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 methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodLock
Locks the event on the given lock object. The context stays locked until the handler is disposed.
(Inherited from CMSEventArgs.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodUsing
Adds the given object to the list of object that get disposed when the handler object is disposed
(Inherited from CMSEventArgs.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldmCallWhenFinished
List of actions to be called when the event finishes
(Inherited from CMSEventArgs.)
Back to Top
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.
(Inherited from DocumentChangeOrderEventArgs TDocument .)
Public propertyNode
Document
(Inherited from DocumentChangeOrderEventArgs TDocument .)
Public propertyOrderType
Defines the order type (First, Last, Alphabetical) if the NewOrder is not specified.
(Inherited from DocumentChangeOrderEventArgs TDocument .)
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertyParameter
Event parameter
(Inherited from CMSEventArgs ParameterType .)
Public propertyRelativeOrder
Indicates if the NewOrder index is relative to current document position.
(Inherited from DocumentChangeOrderEventArgs TDocument .)
Back to Top
See Also