ISaveOperationArguments Interface Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Defines arguments passed to a Content Studio synchronous event handler from the save operation that triggered the event. This interface is used in the OnBeforeDocumentSave event.

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

public interface ISaveOperationArguments

The ISaveOperationArguments type exposes the following members.

Properties

  NameDescription
Public propertyArchiveDate
Gets or sets the archive date of the document that triggered the event. This value can be null to indicate that no archive data should be applied. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyBodyProperties
Set or gets a value that specifies the content of the BODY tag of the document that triggered the event. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyCustomIdentifier
Gets or sets a value that an event handler that implements the OnDocumentPreview event can use to pass an identifier back to Content Studio.
Public propertyIntroduction
Set or gets a value that specifies the introduction content the document that triggered the event. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyKeywords
Gets or sets the keywords of the document that triggered the event. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyMarking
Set or gets a value that specifies a short description of the document that triggered the event. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyMenuData
Set or gets a value that specifies the MenuData for the document that triggered the event. MenuData contains user defined data for menu items and is only applicable if the document acts as a meny node content. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyMenuTarget
Set or gets a value that specifies the MenuTarget for the document that triggered the event. MenuTarget contains a user defined target data for menu items and is only applicable if the document acts as a meny node content. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyMenuUrl
Set or gets a value that specifies the MenuUrl for the document that triggered the event. MenuUrl contains a user defined Url for menu items and is only applicable if the document acts as a meny node content. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyPublishDate
Gets or sets the publish date of the document as passed in by the caller that triggered the event. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyPublished
Gets or sets a value indicating whether the document that triggered the event can be published. The value of this property indicates the value that is about to be saved, not necessarily the current value of the document.
Public propertyUrl
Gets or sets a value that an event handler that implements the OnDocumentPreview event can use to pass an url back to Content Studio.
Top
Remarks

Note Note
This interface is new in Content Studio version 5.3
See Also

Reference