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

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

This class acts as a container for document properties of a Content Studio documents and as a base class for the high-level Content Studio document objects.
Inheritance Hierarchy

SystemObject
  ContentStudio.DocumentCSDocument
    ContentStudio.DocumentCSDocumentInformation

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

[SerializableAttribute]
public class CSDocument

The CSDocument type exposes the following members.

Constructors

  NameDescription
Public methodCSDocument
Constructs a new instance of the CSDocument class
Top
Properties

  NameDescription
Public propertyAllowedFiletypes
Gets or sets the file extensions allowed for this document.
Public propertyArchiveDate
Set or gets a value that specifies the archive date of the document.
Public propertyBodyProperties
Set or gets a value that specifies the content of the document's BODY tag.
Public propertyCategoryID
Set or gets a value that specifies the category of a document. Ignored on update operations.
Public propertyContent
Set or gets a value that specifies the content to save.
Public propertyContentType
Sets or gets the content type (Mime type) of a document.
Public propertyDocumentFileNamingConvention
Gets or sets the document filenaming convention.
Public propertyDocumentID
Set or gets a value that specifies the id of a document. Ignored on create operations.
Public propertyDocumentName
Set or gets a value that specifies the name of the document.
Public propertyEncoding
Gets or sets the encoding.
Public propertyFileExtension
Set or gets a value that specifies the file extension of the document.
Public propertyFileName
Set or gets a value that specifies the file name of a document.
Public propertyGuoid
Set or gets a value that specifies a unique identifier from a copied document.
Public propertyHeaderData
Set or gets a value that specifies the header data.
Public propertyIntroduction
Set or gets a value that specifies the introduction content.
Public propertyIsDirty
Gets a value that specifies whether any updatable properties of the document has been changed.
Public propertyKeywords
Set or gets a value that specifies a list of keywords for the document.
Public propertyMarking
Set or gets a value that specifies a short description of the document.
Public propertyMaxContentSize
Gets or sets the maximum size of the content allowed.
Public propertyMenuData
Set or gets a value that specifies a user defined data for menu items. Only applicable if the document acts as a menu node.
Public propertyMenuTarget
Set or gets a value that specifies the user defined target for menu items. Only applicable if the document acts as a menu node.
Public propertyMenuURL
Set or gets a value that specifies a user defined url data for menu items. Only applicable if the document acts as a menu node.
Public propertyOrderInHierarchy
Set or gets a value that specifies the order in a document hierarchy. Ignored on update operations.
Public propertyParentDocumentID
Set or gets a value that specifies the parent document for a document. Ignored on update operations.
Public propertyPublishDate
Set or gets a value that specifies the publish date of the document.
Public propertyPublished
Set or gets a value that specifies whether the document should be published or not.
Public propertyVirtualPath
Gets or sets the virtual path of this document.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodStatic memberGenerateCustomFileName
Generates a unique file name.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodSetDefault
Sets all the properties to their initial default values
Protected methodSetDirty
Sets the IsDirty property to a new value.
Public methodToString (Inherited from Object.)
Top
Remarks

The usage of the CSDocument class facilitates the complicated save and create operations where it can be passed as the second argument to the hight level save methods. The idea is to set the properties you would like to have a non-default value and pass the object to the high-level save method. In addition to this the class can be used as a return value from classes that return document data.
See Also

Reference