Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Write permission on the document is required.
Some of the properties that involve publishing rules like Published or PublishDate require Approve permission on the document.
If the caller lacks this permission these fields are ignored.
Additionally, if workflow is applicable, workflow rules will apply as well.
[This is preliminary documentation and is subject to change.]
Saves an existing document. The document cannot be a binary document (uploaded file).
This methods supports anonymous callers.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public void Save( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, string documentName, Object published, Object publishDate, Object archiveDate, string marking, string bodyProperties, string fileExtension, string content, string introduction, string headerData, string keywords, string menuData, string menuTarget, string menuUrl, out string retFileName )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - documentId
- Type: ContentStudio.DocumentDocumentId
The id of the document to save. - documentName
- Type: SystemString
The name of the document. This parameter can be null to leave the value as is, but cannot be a zero length string and cannot exceed MAX_DOCUMENTNAME_SIZE number of characters. - published
- Type: SystemObject
Indicates if the document should be published or not. This parameter must be possible to cast or convert to a boolean but can be null to indicate to leave the value as is. - publishDate
- Type: SystemObject
A DateTime value that indicates the date when the document should be published. This parameter must be possible to cast or convert to the DateTime data type but can be null to leave the value as is. - archiveDate
- Type: SystemObject
A DateTime value that indicates when the document should be archived and no longer published. To indicate no limit pass DateTime.MinValue or an empty string. This parameter must be possible to cast or convert to the but can be null to leave the value as is. - marking
- Type: SystemString
A short description of the document. This parameter cannot exceed MAX_MARKING_SIZE number of characters. This parameter can be null to leave the value as is. - bodyProperties
- Type: SystemString
The content of the document's BODY tag. This parameter cannot exceed MAX_BODYPROPERTIES_SIZE number of characters. This parameter can be null to leave the value as is. - fileExtension
- Type: SystemString
The file extension of the document. This parameter cannot exceed MAX_FILE_EXTENSION_SIZE number of characters. This parameter can be null to leave the value as is. - content
- Type: SystemString
The document content to save. This parameter can be null to leave the value as is. - introduction
- Type: SystemString
The introduction content. This parameter can be null to use the default value. Besides being an introduction for a regular document this field is used by Active Scripting components to save their parameter Xml data. - headerData
- Type: SystemString
The header data. This data will form the header element in HTML documents and must be valid according to the actual schema rules for that element. This parameter can be null to leave the value as is. - keywords
- Type: SystemString
A list of keywords for the document. This value cannot exceed MAX_KEYWORD_SIZE characters in length. This parameter can be null to indicate to leave the value as is. - menuData
- Type: SystemString
User defined data for menu items. Only applicable if the document acts as a menu node. This value cannot exceed MAX_MENU_DATA_SIZE characters in length. This parameter can be null to leave the value as is. - menuTarget
- Type: SystemString
User defined target for menu items. Only applicable if the document acts as a menu node. This value cannot exceed MAX_MENU_TARGET_SIZE characters in length. This parameter can be null to leave the value as is. - menuUrl
- Type: SystemString
User defined url data for menu items. Only applicable if the document acts as a menu node. This value cannot exceed MAX_MENU_URL_SIZE characters in length. This parameter can be null to leave the value as is. - retFileName
- Type: SystemString
Returns the relative filename of the document
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database. |
ArgumentNullException | A parameter cannot be null. |
ArgumentOutOfRangeException | The file name passed in is reserved |
ArgumentException | A parameter data exceeded its maximum allowed length. |
SqlException | An error occurred when executing the command against the Content Studio database |
InvalidOperationException | Cannot call the SaveContent method for uploaded files |
Content Studio permissions
See Also