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

[This is preliminary documentation and is subject to change.]

Represents an event handler that handles the OnDocumentPreview synchronous event in Content Studio 5.3 and later.
Inheritance Hierarchy

SystemObject
  ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
    ContentStudio.EventActions.SynchronousEventHandlersDocumentPreviewSyncHandler

Namespace: ContentStudio.EventActions.SynchronousEventHandlers
Assembly: SyncEvtHand (in SyncEvtHand.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public abstract class DocumentPreviewSyncHandler : SynchronousEventHandlerBase, 
	ISingleSynchronousHandler

The DocumentPreviewSyncHandler type exposes the following members.

Constructors

  NameDescription
Protected methodDocumentPreviewSyncHandler
Initializes a new instance of the DocumentPreviewSyncHandler 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.
(Inherited from SynchronousEventHandlerBase.)
Public propertyArchiveDate
Gets the archive date of the document that triggered the event. This value can be null to indicate no limit.
(Inherited from SynchronousEventHandlerBase.)
Public propertyASCode
The Active Scripting component markup data of the Active Scripting component being previewed. Only documents that are Active Scripting components have this property set.
Public propertyBodyProperties
The content of the body tag of the document being preview. This property is emtpy unless the document has meta data.
Public propertyCalledByUser
Gets an object that represents the user that initiated the event.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCallerEmailAddress
Gets or sets the caller email address.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCallerLogOnName
Gets the logon name of the calling user.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCallerName
Gets the name of the caller.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCallerSessionId
Gets the caller's session id.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCallerSid
Gets the SecurityIdentifier of the calling user.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCallerUserKey
Gets the caller's user key.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCancel
Gets or sets a value indicating whether this SynchronousEventHandlerBase is cancelled.
(Inherited from SynchronousEventHandlerBase.)
Public propertyCategoryId
Gets the category id.
(Inherited from SynchronousEventHandlerBase.)
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
(Inherited from SynchronousEventHandlerBase.)
Public propertyConnectionId
Gets or sets the connection id.
(Inherited from SynchronousEventHandlerBase.)
Public propertyContent
Gets or sets the content of the affected Content Studio document.
(Inherited from SynchronousEventHandlerBase.)
Public propertyContentBinary
Gets the binary content passed in.
(Inherited from SynchronousEventHandlerBase.)
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).
(Inherited from SynchronousEventHandlerBase.)
Public propertyCredentials
Gets the credentials passed in to the event handler.
(Inherited from SynchronousEventHandlerBase.)
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
(Inherited from SynchronousEventHandlerBase.)
Public propertyDocumentId
Gets the document id.
(Inherited from SynchronousEventHandlerBase.)
Public propertyDocumentName
Gets or sets the name of the document.
(Inherited from SynchronousEventHandlerBase.)
Public propertyDocumentStatus
Gets a value that specifies a set of different status properties of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.)
Public propertyDocumentTitle
Gets or sets the document title.
(Inherited from SynchronousEventHandlerBase.)
Public propertyDocumentType
Gets the type of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.)
Public propertyEncodingName
Gets or sets the encoding name of the document. This value can be null
(Inherited from SynchronousEventHandlerBase.)
Public propertyEptContent
Gets the content of the ept document as an object as Content Studio's implementation of the ICSEptContent interface.
(Inherited from SynchronousEventHandlerBase.)
Public propertyEtXml
Ept xml that contains default field values for a presentation template. These values are calculated from the default field values in the Editing template.
Public propertyEtXmlFilename
The virtual path to the preview ETXml file that contains Ept data with default values from an edit template when previewing a presentation template.
Public propertyEventHandlerName
Gets the name of the event handler.
(Inherited from SynchronousEventHandlerBase.)
Public propertyEventId
Gets the event id.
(Inherited from SynchronousEventHandlerBase.)
Public propertyEventIdentifier
Gets the numeric identifier of the event that is allowed by this Content Studio event handler.
Public propertyEventName
Gets the name of the event.
Public propertyEventTimestamp
Gets the event timestamp.
(Inherited from SynchronousEventHandlerBase.)
Public propertyExtendedProperties
Gets a collection of extended properties passed in.
(Inherited from SynchronousEventHandlerBase.)
Public propertyFileExtension
The file extension of the document being previewed.
Public propertyFileName
Gets or sets the name of the document's file of disc.
(Inherited from SynchronousEventHandlerBase.)
Public propertyGuoid
Gets the Guoid identifier of the document.
(Inherited from SynchronousEventHandlerBase.)
Public propertyHeaderProperties
The content of the header section of the document being preview. This property emtpy unless the document has meta data.
Public propertyIsActiveScript
Indicates whether the document previewed is an Active Scripting component.
Public propertyMessageId
Gets or sets the message id.
(Inherited from SynchronousEventHandlerBase.)
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.
(Inherited from SynchronousEventHandlerBase.)
Public propertyPreviewFilename
The virtual path to a temporary file on the server that contains preview data.
Public propertyPublishDate
Gets the publish date of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.)
Public propertyRegisterXml
Xml containing data directive information for the ASP.Net server or user controls that must be dynamically registered on the previewed document.
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.
(Inherited from SynchronousEventHandlerBase.)
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
(Inherited from SynchronousEventHandlerBase.)
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.
(Inherited from SynchronousEventHandlerBase.)
Public propertyStatus
Gets or sets the status in the event handler call.
(Inherited from SynchronousEventHandlerBase.)
Public propertyStatusText
Gets or sets the status text in the event handler call.
(Inherited from SynchronousEventHandlerBase.)
Public propertyTempFilename
The physical path to on the server that contains preview data.
Public propertyVirtualPath
Gets the virtual path of the document.
(Inherited from SynchronousEventHandlerBase.)
Top
Methods

  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SynchronousEventHandlerBase.)
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources
(Inherited from SynchronousEventHandlerBase.)
Protected methodDoWork
When implemented in derived class performs the actual work in the event handler.
(Inherited from SynchronousEventHandlerBase.)
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.
(Inherited from SynchronousEventHandlerBase.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the SynchronousEventHandlerBase is reclaimed by garbage collection.
(Inherited from SynchronousEventHandlerBase.)
Protected methodFinish
Performs actions after that the actual work of the event handler has finished.
(Inherited from SynchronousEventHandlerBase.)
Public methodCode exampleGetCustomConfiguration
Gets a configuration file with a specific name. This file is located in the same directory as the Content Studio runtime.
(Inherited from SynchronousEventHandlerBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodInit
Inits this instance.
(Inherited from SynchronousEventHandlerBase.)
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.
(Inherited from SynchronousEventHandlerBase.)
Protected methodParseInputXml
Parses the xml passed in the eventhandler's eventXmlArguments argument.
(Overrides SynchronousEventHandlerBaseParseInputXml(String).)
Public methodToString (Inherited from Object.)
Protected methodValidateEvent
Examines the event that triggered this event handler and returns a value that specifies whether the handler is valid for the event executed.
(Overrides SynchronousEventHandlerBaseValidateEvent(Int32).)
Top
Remarks

The OnDocumentPreview synchronus event occurs just before that a document is being previewed. An event handler for this event can be used with implementations that stores their content outside of Content Studio.

This class requires and was introduced in Content Studio version 5.3.

See Also

Reference

Other Resources