Click or drag to resize
DocumentsExportEventArgs Class
Document export event arguments
Inheritance Hierarchy

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 10.0.0
Syntax
C#
public class DocumentsExportEventArgs : ExportEventArgs

The DocumentsExportEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodDocumentsExportEventArgs
Top
Properties
  NameDescription
Public propertyCurrentHandler
Currently executing handler
(Inherited from CMSEventArgs.)
Public propertyData
Exported data. Available only in ExportObjects.After and ExportDocuments.After handler
(Inherited from ExportEventArgs.)
Public propertyObjectType
Object type which is exported
(Inherited from ExportEventArgs.)
Public propertyOriginalEventArgs
Original event arguments for the event
(Inherited from CMSEventArgs.)
Public propertySettings
Export settings
(Inherited from ExportBaseEventArgs.)
Public propertySiteObjects
Flag whether the system exports the site objects or global objects
(Inherited from ExportEventArgs.)
Public propertyTranslationHelper
Translation helper
(Inherited from ExportEventArgs.)
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
Extension Methods
  NameDescription
Public Extension MethodUseTransaction
Ensures that the event uses transaction
(Defined by DataExtensions.)
Top
See Also