[This is preliminary documentation and is subject to change.]
Namespace: ContentStudio.EventActions
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
| Member name | Value | Description | |
|---|---|---|---|
| Unspecified | -1 | The event is unspecified or unknown. Value is -1. | |
| OnXMLIndexChange | 3 | Occurs when a change in a document demands an update of the underlying xml index. Value is 3. | |
| OnDocumentApprove | 4 | Occurs when a document is approved. Value is 4. | |
| OnDocumentDelete | 5 | Occurs when a document is thrown in the recycling bin. Value is 5. | |
| OnDocumentDestroy | 6 | Occurs when a document is permanently deleted. Value is 6. | |
| OnDocumentExpire | 7 |
Occurs when a document has expired. Supported in CS 5.2 and later.
Value is 7.
Not supported for synchronous events. | |
| OnDocumentPublish | 8 |
Occurs when a document is published. Supported in CS 5.2 and later.
Value is 8.
Not supported for synchronous events. | |
| OnDocumentReject | 9 |
Occurs when a document is rejected.
Value is 9.
Not supported for synchronous events before version 5.2. | |
| OnDocumentRevision | 10 | Occurs when a document is sent for versioning. Value is 10. | |
| OnDocumentSave | 11 | Occurs when a document content is saved. Value is 11. | |
| OnDocumentCreate | 27 | Occurs when a document is created. Value is 27. | |
| OnDocumentCheckOut | 28 |
Occurs when a document is checked out. Value is 28
Not supported for synchronous events prior to version 5.2. | |
| OnDocumentCheckIn | 29 |
Occurs when a document is checked in.
Value is 29.
Not supported for synchronous events prior to version 5.2. | |
| OnDocumentUnpublish | 30 |
Occurs when a document is no longer published.
Supported in Content Studio version 5.2. Value is 30.
This event is generated when a published document's publish date is set to a value in the future or when the published flag is turned off. Not supported for synchronous. | |
| OnDocumentSubscription | 31 | Occurs when a document is being sent out to subscribers. Supported in Content Studio version 5.2 and later. Value is 31. | |
| OnTestDocumentSubscription | 32 |
Occurs when a document is being sent out to subscribers for testing.
Supported in Content Studio version 5.2. Value is 32.
The difference between the OnTestDocumentSubscription and the OnDocumentSubscription events is that OnTestDocumentSubscription is added directly by a user activity and does not take the subscription status on the document in consideration. Also an eventhandler that implements this event sends a message only to the specified user. | |
| OnBeforeDocumentSave | 33 |
Occurs when a document is about to be saved.
Supported in Content Studio version 5.2 and later. Value is 33.
This event is synchronous only and enables an event handler to read content of a document before it has been saved or created. For binary uploaded files the event handler can access the temporary file just uploaded and check its content e.g. scan it for viruses. If the event handler cancels this event the document will not be saved or created. | |
| OnBeforeDocumentSynchronize | 34 |
Occurs when a document is about to get synchronized by the
SyncronizeFolder
method.
Supported in Content Studio version 5.2 RC 1 and later. Value is 34.
This event is synchronous only. | |
| OnXmlIndexSave | 35 |
This event occurs when the Xml index data of a document has to be saved into the Content Studio Xml index.
Supported in Content Studio version 5.2 RC 1. Value is 35.
This event is synchronous only and is triggered for each save operation against the Xml index. Since the ReIndexDocument method that gets called by the ServiceManager when the Xml index is synchronized, this event might be called twice, once for the approved content and once for the draft content. The OnXmlIndexSave event is meaningful for EPT data categories only and is typically used when there is a need to synchronize ept indexed data with an external data storage. for more information on this event see the article OnXmlIndexSave event data in our knowledgebase. | |
| OnXmlIndexFieldDelete | 36 |
This event occurs when a EPT field the Xml index has been deleted.
Supported in Content Studio version 5.2 RC 1. Value is 36.
This event is synchronous only and is triggered for each delete operation against the Xml index. The OnXmlIndexFieldDelete event is meaningful for EPT data categories only and is typically used when there is a need to synchronize ept indexed data with an external data storage. for more information on this event see the article OnXmlIndexFieldDelete event data in our knowledgebase. | |
| OnDocumentRestore | 37 |
This event occurs when a document has been restored from the recycling bin
Supported in Content Studio version 5.2 and later. Value is 37.
Currently, this event is synchronous only. | |
| OnDocumentMoveInHierarchy | 38 |
This event occurs when a document has been moved from one parent document to another
or to another position within level.
Supported in Content Studio version 5.2 and later. Value is 38.
Currently, this event is synchronous only. | |
| OnDocumentRevisionRestore | 39 |
This event occurs when an older version of a document is restored and the current
document draft is replaced with this version.
Supported in Content Studio version 5.3 and later. Value is 39.
Currently, this event is synchronous only. | |
| OnDocumentPreview | 40 |
This event occurs when a document is previewed in Content Studio
Supported in Content Studio version 5.3 and later. Value is 40.
This event is synchronous only. | |
| OnDocumentPreviewDispose | 41 |
This event occurs when document preview data is disposed after a preview operation.
Supported in Content Studio version 5.3 and later. Value is 41.
This event is synchronous only. |