Content Studio Web Content Management System
Top
[This is preliminary documentation and is subject to change.]
The DocumentPreviewSyncHandler type exposes the following members.
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.
(Inherited from SynchronousEventHandlerBase.) |
|
ArchiveDate |
Gets the archive date of the document that triggered the event.
This value can be null to indicate no limit.
(Inherited from SynchronousEventHandlerBase.) |
|
ASCode |
The Active Scripting component markup data of the Active Scripting component being previewed.
Only documents that are Active Scripting components have this property set.
|
|
BodyProperties |
The content of the body tag of the document being preview.
This property is emtpy unless the document has meta data.
|
|
CalledByUser |
Gets an object that represents the user that initiated the event.
(Inherited from SynchronousEventHandlerBase.) |
|
CallerEmailAddress |
Gets or sets the caller email address.
(Inherited from SynchronousEventHandlerBase.) |
|
CallerLogOnName |
Gets the logon name of the calling user.
(Inherited from SynchronousEventHandlerBase.) |
|
CallerName |
Gets the name of the caller.
(Inherited from SynchronousEventHandlerBase.) |
|
CallerSessionId |
Gets the caller's session id.
(Inherited from SynchronousEventHandlerBase.) |
|
CallerSid |
Gets the SecurityIdentifier of the calling user.
(Inherited from SynchronousEventHandlerBase.) |
|
CallerUserKey |
Gets the caller's user key.
(Inherited from SynchronousEventHandlerBase.) |
|
Cancel |
Gets or sets a value indicating whether this SynchronousEventHandlerBase is cancelled.
(Inherited from SynchronousEventHandlerBase.) |
|
CategoryId |
Gets the category id.
(Inherited from SynchronousEventHandlerBase.) |
|
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
(Inherited from SynchronousEventHandlerBase.) |
|
ConnectionId |
Gets or sets the connection id.
(Inherited from SynchronousEventHandlerBase.) |
|
Content |
Gets or sets the content of the affected Content Studio document.
(Inherited from SynchronousEventHandlerBase.) |
|
ContentBinary |
Gets the binary content passed in.
(Inherited from SynchronousEventHandlerBase.) |
|
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).
(Inherited from SynchronousEventHandlerBase.) |
|
Credentials |
Gets the credentials passed in to the event handler.
(Inherited from SynchronousEventHandlerBase.) |
|
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
(Inherited from SynchronousEventHandlerBase.) |
|
DocumentId |
Gets the document id.
(Inherited from SynchronousEventHandlerBase.) |
|
DocumentName |
Gets or sets the name of the document.
(Inherited from SynchronousEventHandlerBase.) |
|
DocumentStatus |
Gets a value that specifies a set of different status properties of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.) |
|
DocumentTitle |
Gets or sets the document title.
(Inherited from SynchronousEventHandlerBase.) |
|
DocumentType |
Gets the type of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.) |
|
EncodingName |
Gets or sets the encoding name of the document. This value can be null (Inherited from SynchronousEventHandlerBase.) |
|
EptContent |
Gets the content of the ept document as an object as Content Studio's implementation of the ICSEptContent interface.
(Inherited from SynchronousEventHandlerBase.) |
|
EtXml |
Ept xml that contains default field values for a presentation template. These values are calculated from the default field values in the
Editing template.
|
|
EtXmlFilename |
The virtual path to the preview ETXml file that contains Ept data with default values from an edit template when previewing a presentation template.
|
|
EventHandlerName |
Gets the name of the event handler.
(Inherited from SynchronousEventHandlerBase.) |
|
EventId |
Gets the event id.
(Inherited from SynchronousEventHandlerBase.) |
|
EventIdentifier |
Gets the numeric identifier of the event that is allowed by this Content Studio event handler.
|
|
EventName |
Gets the name of the event.
|
|
EventTimestamp |
Gets the event timestamp.
(Inherited from SynchronousEventHandlerBase.) |
|
ExtendedProperties |
Gets a collection of extended properties passed in.
(Inherited from SynchronousEventHandlerBase.) |
|
FileExtension |
The file extension of the document being previewed.
|
|
FileName |
Gets or sets the name of the document's file of disc.
(Inherited from SynchronousEventHandlerBase.) |
|
Guoid |
Gets the Guoid identifier of the document.
(Inherited from SynchronousEventHandlerBase.) |
|
HeaderProperties |
The content of the header section of the document being preview.
This property emtpy unless the document has meta data.
|
|
IsActiveScript |
Indicates whether the document previewed is an Active Scripting component.
|
|
MessageId |
Gets or sets the message id.
(Inherited from SynchronousEventHandlerBase.) |
|
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.
(Inherited from SynchronousEventHandlerBase.) |
|
PreviewFilename |
The virtual path to a temporary file on the server that contains preview data.
|
|
PublishDate |
Gets the publish date of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.) |
|
RegisterXml |
Xml containing data directive information for the ASP.Net server or user controls that must be dynamically registered on the previewed document.
|
|
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.
(Inherited from SynchronousEventHandlerBase.) |
|
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 (Inherited from SynchronousEventHandlerBase.) |
|
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.
(Inherited from SynchronousEventHandlerBase.) |
|
Status |
Gets or sets the status in the event handler call.
(Inherited from SynchronousEventHandlerBase.) |
|
StatusText |
Gets or sets the status text in the event handler call.
(Inherited from SynchronousEventHandlerBase.) |
|
TempFilename |
The physical path to on the server that contains preview data.
|
|
VirtualPath |
Gets the virtual path of the document.
(Inherited from SynchronousEventHandlerBase.) |
See Also