Content Studio Web Content Management System
SystemObject
ContentStudio.DocumentCSDocument
ContentStudio.DocumentCSDocumentInformation
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
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.
[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
ContentStudio.DocumentCSDocument
ContentStudio.DocumentCSDocumentInformation
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The CSDocument type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CSDocument |
Constructs a new instance of the CSDocument class
|
Properties
Name | Description | |
---|---|---|
AllowedFiletypes |
Gets or sets the file extensions allowed for this document.
| |
ArchiveDate |
Set or gets a value that specifies the archive date of the document.
| |
BodyProperties |
Set or gets a value that specifies the content of the document's BODY tag.
| |
CategoryID |
Set or gets a value that specifies the category of a document. Ignored on update operations.
| |
Content |
Set or gets a value that specifies the content to save.
| |
ContentType |
Sets or gets the content type (Mime type) of a document.
| |
DocumentFileNamingConvention |
Gets or sets the document filenaming convention.
| |
DocumentID |
Set or gets a value that specifies the id of a document. Ignored on create operations.
| |
DocumentName |
Set or gets a value that specifies the name of the document.
| |
Encoding |
Gets or sets the encoding.
| |
FileExtension |
Set or gets a value that specifies the file extension of the document.
| |
FileName |
Set or gets a value that specifies the file name of a document.
| |
Guoid |
Set or gets a value that specifies a unique identifier from a copied document.
| |
HeaderData |
Set or gets a value that specifies the header data.
| |
Introduction |
Set or gets a value that specifies the introduction content.
| |
IsDirty |
Gets a value that specifies whether any updatable properties of the document has been changed.
| |
Keywords |
Set or gets a value that specifies a list of keywords for the document.
| |
Marking |
Set or gets a value that specifies a short description of the document.
| |
MaxContentSize |
Gets or sets the maximum size of the content allowed.
| |
MenuData |
Set or gets a value that specifies a user defined data for menu items. Only applicable if the document acts as a menu node.
| |
MenuTarget |
Set or gets a value that specifies the user defined target for menu items. Only applicable if the document acts as a menu node.
| |
MenuURL |
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.
| |
OrderInHierarchy |
Set or gets a value that specifies the order in a document hierarchy. Ignored on update operations.
| |
ParentDocumentID |
Set or gets a value that specifies the parent document for a document. Ignored on update operations.
| |
PublishDate |
Set or gets a value that specifies the publish date of the document.
| |
Published |
Set or gets a value that specifies whether the document should be published or not.
| |
VirtualPath |
Gets or sets the virtual path of this document.
|
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GenerateCustomFileName |
Generates a unique file name.
| |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
SetDefault |
Sets all the properties to their initial default values
| |
SetDirty |
Sets the IsDirty property to a new value.
| |
ToString | (Inherited from Object.) |
Remarks
See Also