Content Studio Web Content Management System
SystemObject
ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
More...
Assembly: SyncEvtHand (in SyncEvtHand.dll) Version: 1.0.0.0 (1.0.0.0)
Top
Top
Top
SystemObject
ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
ContentStudio.EventActions.SynchronousEventHandlersBeforeDocumentSaveSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersBeforeDocumentSynchronizeSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentApproveSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCheckInSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCheckOutSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCreateSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentDeleteSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentDestroySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentMoveInHierarchySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentPreviewDisposeSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentPreviewSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRejectSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRestoreSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRevisionRestoreSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRevisionSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentSaveSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersPolicyBasedSynchronousEventHandler
ContentStudio.EventActions.SynchronousEventHandlersXmlIndexSyncHandler
[This is preliminary documentation and is subject to change.]
Provides a base class for event handlers that handles
synchronous events in Content Studio.
Inheritance Hierarchy
ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
More...
Namespace: ContentStudio.EventActions.SynchronousEventHandlers
Assembly: SyncEvtHand (in SyncEvtHand.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public abstract class SynchronousEventHandlerBase : ICSEventHandler, ICSEventHandler2, IDisposable
The SynchronousEventHandlerBase type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SynchronousEventHandlerBase |
Initializes a new instance of the SynchronousEventHandlerBase class.
|
Properties
Name | Description | |
---|---|---|
ApprovedByUser |
Gets an object that represents the user that approved the document that triggered the event.
This value is null if the document is not approved yet.
| |
ArchiveDate |
Gets the archive date of the document that triggered the event.
This value can be null to indicate no limit.
| |
CalledByUser |
Gets an object that represents the user that initiated the event.
| |
CallerEmailAddress |
Gets or sets the caller email address.
| |
CallerLogOnName |
Gets the logon name of the calling user.
| |
CallerName |
Gets the name of the caller.
| |
CallerSessionId |
Gets the caller's session id.
| |
CallerSid |
Gets the SecurityIdentifier of the calling user.
| |
CallerUserKey |
Gets the caller's user key.
| |
Cancel |
Gets or sets a value indicating whether this SynchronousEventHandlerBase is cancelled.
| |
CategoryId |
Gets the category id.
| |
CheckedOutByUser |
Gets an object that represents the user that has checked out the document that triggered the event.
This value is null if the document is not checked out
| |
ConnectionId |
Gets or sets the connection id.
| |
Content |
Gets or sets the content of the affected Content Studio document.
| |
ContentBinary |
Gets the binary content passed in.
| |
CreatedByUser |
Gets an object that represents the user that created the document that triggered the event.
This value is null if the document is not yet created (OnBeforeDocumentSave).
| |
Credentials |
Gets the credentials passed in to the event handler.
| |
DeletedByUser |
Gets an object that represents the user that deleted the document that triggered the event.
This value is null if the document is not deleted
| |
DocumentId |
Gets the document id.
| |
DocumentName |
Gets or sets the name of the document.
| |
DocumentStatus |
Gets a value that specifies a set of different status properties of the document that triggered the event.
| |
DocumentTitle |
Gets or sets the document title.
| |
DocumentType |
Gets the type of the document that triggered the event.
| |
EncodingName |
Gets or sets the encoding name of the document. This value can be null | |
EptContent |
Gets the content of the ept document as an object as Content Studio's implementation of the ICSEptContent interface.
| |
EventHandlerName |
Gets the name of the event handler.
| |
EventId |
Gets the event id.
| |
EventTimestamp |
Gets the event timestamp.
| |
ExtendedProperties |
Gets a collection of extended properties passed in.
| |
FileName |
Gets or sets the name of the document's file of disc.
| |
Guoid |
Gets the Guoid identifier of the document.
| |
MessageId |
Gets or sets the message id.
| |
ModifiedByUser |
Gets an object that represents the user that modified the document that triggered the event.
This value is null if the document is not modified.
| |
PublishDate |
Gets the publish date of the document that triggered the event.
| |
RejectedByUser |
Gets an object that represents the user rejected the document that triggered the event.
This value is null if the document is not sent for revison and has not been rejected.
| |
SaveOperationArguments |
Gets an object that contains the argument that was passed in to the save operation operation that triggered the event.
This property has a value only for the OnBeforeDocumentSave and the OnDocumentPreview events, otherwise the value is null | |
SentForApprovalByUser |
Gets an object that represents the user sent the document that triggered the event for revision.
This value is null if the document is not sent for revison.
| |
Status |
Gets or sets the status in the event handler call.
| |
StatusText |
Gets or sets the status text in the event handler call.
| |
VirtualPath |
Gets the virtual path of the document.
|
Methods
Name | Description | |
---|---|---|
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
| |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources
| |
DoWork |
When implemented in derived class performs the actual work in the event handler.
| |
Equals | (Inherited from Object.) | |
EventHandler |
Defines a standard event handler for Content Studio syncronous server side events.
Content Studio calls this implements this interface when an synchrous event occurs.
| |
EventToName |
Gets the name of the event that triggered this event handler ex. OnDocumentSave.
| |
Finalize |
Releases unmanaged resources and performs other cleanup operations before the
SynchronousEventHandlerBase is reclaimed by garbage collection.
(Overrides ObjectFinalize.) | |
Finish |
Performs actions after that the actual work of the event handler has finished.
| |
GetCustomConfiguration |
Gets a configuration file with a specific name. This file is located in the same directory as the
Content Studio runtime.
| |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Init |
Inits this instance.
| |
MemberwiseClone | (Inherited from Object.) | |
ParseCustomData |
When implemented in derived classes, parses the custom data passed in to the event handler's
customData parameter.
| |
ParseInputXml |
Parses the xml passed in the eventhandler's eventXmlArguments argument.
| |
ToString | (Inherited from Object.) | |
ValidateEvent |
When implemented in derived classes, examines the event that triggered this event
handler and returns a value that specifies whether the handler is valid for the
event executed.
|
Remarks
This class was introduced in Content Studio version 5.2.
Even though you can derive directly from this base class when you create a synchronous event handler in Content Studio version 5.2 and later, unless your event handler should be able to handle multiple events, it is recommended to use some of the specialized derived class as a base class for your event handler implementation.
See Also
Reference
Other Resources
Inheritance Hierarchy
ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
ContentStudio.EventActions.SynchronousEventHandlersBeforeDocumentSaveSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersBeforeDocumentSynchronizeSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentApproveSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCheckInSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCheckOutSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCreateSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentDeleteSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentDestroySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentMoveInHierarchySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentPreviewDisposeSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentPreviewSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRejectSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRestoreSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRevisionRestoreSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRevisionSyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentSaveSyncHandler
ContentStudio.EventActions.SynchronousEventHandlersPolicyBasedSynchronousEventHandler
ContentStudio.EventActions.SynchronousEventHandlersXmlIndexSyncHandler