[This is preliminary documentation and is subject to change.]
ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
ContentStudio.EventActions.SynchronousEventHandlersPolicyBasedSynchronousEventHandler
More...
Namespace: ContentStudio.EventActions.SynchronousEventHandlers
Assembly: SyncEvtHand (in SyncEvtHand.dll) Version: 1.0.0.0 (1.0.0.0)
The PolicyBasedSynchronousEventHandler type exposes the following members.
Name | Description | |
---|---|---|
PolicyBasedSynchronousEventHandler |
Initializes a new instance of the PolicyBasedSynchronousEventHandler class.
|
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.) | |
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.) | |
EventHandlerName |
Gets the name of the event handler.
(Inherited from SynchronousEventHandlerBase.) | |
EventId |
Gets the event id.
(Inherited from SynchronousEventHandlerBase.) | |
EventTimestamp |
Gets the event timestamp.
(Inherited from SynchronousEventHandlerBase.) | |
ExtendedProperties |
Gets a collection of extended properties passed in.
(Inherited from SynchronousEventHandlerBase.) | |
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.) | |
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.) | |
Policies |
Gets a list of custom policies that was sent in from the event actions definition.
| |
PublishDate |
Gets the publish date of the document that triggered the event.
(Inherited from SynchronousEventHandlerBase.) | |
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.) | |
VirtualPath |
Gets the virtual path of the document.
(Inherited from SynchronousEventHandlerBase.) |
Name | Description | |
---|---|---|
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SynchronousEventHandlerBase.) | |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources
(Inherited from SynchronousEventHandlerBase.) | |
DoWork |
When implemented in derived class performs the actual work in the event handler.
(Inherited from SynchronousEventHandlerBase.) | |
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.
(Inherited from SynchronousEventHandlerBase.) | |
Finalize |
Releases unmanaged resources and performs other cleanup operations before the
SynchronousEventHandlerBase is reclaimed by garbage collection.
(Inherited from SynchronousEventHandlerBase.) | |
Finish |
Performs actions after that the actual work of the event handler has finished.
(Inherited from SynchronousEventHandlerBase.) | |
GetCustomConfiguration |
Gets a configuration file with a specific name. This file is located in the same directory as the
Content Studio runtime.
(Inherited from SynchronousEventHandlerBase.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
GetValidationXmlSchema |
Gets the XML schema that is used to validate the passed in XML-based policy definitions.
| |
Init |
Inits this instance and performs the actual validation operation
(Overrides SynchronousEventHandlerBaseInit.) | |
InterpretPolicyValue |
Interprets the value of a specific Policy.
| |
MemberwiseClone | (Inherited from Object.) | |
ParseCustomData |
Parses the xml based custom data that contains the policy definitions.
This data is supplied by the person in Content Studio that creates the
event subscription.
(Overrides SynchronousEventHandlerBaseParseCustomData(String).) | |
ParseInputXml |
Parses the xml passed in the eventhandler's eventXmlArguments argument.
(Inherited from SynchronousEventHandlerBase.) | |
PerformPolicyValidation |
Performs the policy validation.
| |
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.
(Inherited from SynchronousEventHandlerBase.) | |
ValidatePolicy |
When implemented in derived classes validates that the affected Content Studio document meets the rule specified in the policy.
|
Note |
---|
This class was added in Content Studio version 5.2 SP1. |
The policy is provided as data in the Custom data property in Content Studio and each policy is Xml based.
The following xml fragment shows an example of a policy
<customData> <policies> <policy Enabled="true" Name="MaxUploadedFileSize" Value="23" ValueClass="Mb" InterpretValueAs="Maximum" Description="Policy: Limits the size of an uploaded file." ViolationMessage="A rule on this web site limits the size of an uploaded file, Please use a smaller file instead. Max value = {0}" /> </policies> </customData>
Even though you can derive directly from this base class when you create a validating 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.
Reference
Other Resources
ContentStudio.EventActions.SynchronousEventHandlersSynchronousEventHandlerBase
ContentStudio.EventActions.SynchronousEventHandlersPolicyBasedSynchronousEventHandler
ContentStudio.EventActions.SynchronousEventHandlersBeforeDocumentSavePolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersBeforeDocumentSynchronizePolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentApprovePolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCheckInPolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCheckOutPolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentCreatePolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentDeletePolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentDestroyPolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentMoveInHierarchyPolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRejectPolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRestorePolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRevisionPolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentRevisionRestorePolicySyncEventHandler
ContentStudio.EventActions.SynchronousEventHandlersDocumentSavePolicySyncHandler
ContentStudio.EventActions.SynchronousEventHandlersXmlIndexPolicySyncHandler