SynchronousEventHandlerBase Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[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

SystemObject
  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

  NameDescription
Protected methodSynchronousEventHandlerBase
Initializes a new instance of the SynchronousEventHandlerBase class.
Top
Properties

  NameDescription
Public propertyApprovedByUser
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.
Public propertyArchiveDate
Gets the archive date of the document that triggered the event. This value can be null to indicate no limit.
Public propertyCalledByUser
Gets an object that represents the user that initiated the event.
Public propertyCallerEmailAddress
Gets or sets the caller email address.
Public propertyCallerLogOnName
Gets the logon name of the calling user.
Public propertyCallerName
Gets the name of the caller.
Public propertyCallerSessionId
Gets the caller's session id.
Public propertyCallerSid
Gets the SecurityIdentifier of the calling user.
Public propertyCallerUserKey
Gets the caller's user key.
Public propertyCancel
Gets or sets a value indicating whether this SynchronousEventHandlerBase is cancelled.
Public propertyCategoryId
Gets the category id.
Public propertyCheckedOutByUser
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
Public propertyConnectionId
Gets or sets the connection id.
Public propertyContent
Gets or sets the content of the affected Content Studio document.
Public propertyContentBinary
Gets the binary content passed in.
Public propertyCreatedByUser
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).
Public propertyCredentials
Gets the credentials passed in to the event handler.
Public propertyDeletedByUser
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
Public propertyDocumentId
Gets the document id.
Public propertyDocumentName
Gets or sets the name of the document.
Public propertyDocumentStatus
Gets a value that specifies a set of different status properties of the document that triggered the event.
Public propertyDocumentTitle
Gets or sets the document title.
Public propertyDocumentType
Gets the type of the document that triggered the event.
Public propertyEncodingName
Gets or sets the encoding name of the document. This value can be null
Public propertyEptContent
Gets the content of the ept document as an object as Content Studio's implementation of the ICSEptContent interface.
Public propertyEventHandlerName
Gets the name of the event handler.
Public propertyEventId
Gets the event id.
Public propertyEventTimestamp
Gets the event timestamp.
Public propertyExtendedProperties
Gets a collection of extended properties passed in.
Public propertyFileName
Gets or sets the name of the document's file of disc.
Public propertyGuoid
Gets the Guoid identifier of the document.
Public propertyMessageId
Gets or sets the message id.
Public propertyModifiedByUser
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.
Public propertyPublishDate
Gets the publish date of the document that triggered the event.
Public propertyRejectedByUser
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.
Public propertySaveOperationArguments
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
Public propertySentForApprovalByUser
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.
Public propertyStatus
Gets or sets the status in the event handler call.
Public propertyStatusText
Gets or sets the status text in the event handler call.
Public propertyVirtualPath
Gets the virtual path of the document.
Top
Methods

  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources
Protected methodDoWork
When implemented in derived class performs the actual work in the event handler.
Public methodEquals (Inherited from Object.)
Public methodEventHandler
Defines a standard event handler for Content Studio syncronous server side events. Content Studio calls this implements this interface when an synchrous event occurs.
Protected methodStatic memberEventToName
Gets the name of the event that triggered this event handler ex. OnDocumentSave.
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the SynchronousEventHandlerBase is reclaimed by garbage collection.
(Overrides ObjectFinalize.)
Protected methodFinish
Performs actions after that the actual work of the event handler has finished.
Public methodCode exampleGetCustomConfiguration
Gets a configuration file with a specific name. This file is located in the same directory as the Content Studio runtime.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodInit
Inits this instance.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodParseCustomData
When implemented in derived classes, parses the custom data passed in to the event handler's customData parameter.
Protected methodParseInputXml
Parses the xml passed in the eventhandler's eventXmlArguments argument.
Public methodToString (Inherited from Object.)
Protected methodValidateEvent
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.
Top
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

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