Content Studio Web Content Management System
SystemObject
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudio.DocumentDocumentSystemBase
ContentStudio.DocumentDocumentBase
ContentStudio.DocumentDocumentManager
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
This class contains low-level methods that enables you to manage any type of document in Content Studio.
A much more user friendly way of working with Content Studio documents is one of the high-level document
classes. See the See also section for links to the documentation of these classes.
[This is preliminary documentation and is subject to change.]
This class manages documents in Content Studio.
Inheritance Hierarchy
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudio.DocumentDocumentSystemBase
ContentStudio.DocumentDocumentBase
ContentStudio.DocumentDocumentManager
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The DocumentManager type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DocumentManager | Initializes a new instance of the DocumentManager class |
Methods
| Name | Description | |
|---|---|---|
| AddToFavourites(ConnectionId, SessionId, DocumentId) |
Adds a document to the list of favorite documents.
|
| AddToFavourites(ConnectionId, SessionId, String, Int32, String) |
Adds a document to the list of favorite documents.
|
| Approve(ConnectionId, SessionId, DocumentId) |
Creates a new revision of the document that will act as the new currently published version of the document.
The current published content will be transferred to document history.
Documents that are of the File type cannot be approved using this method.
This methods supports anonymous callers.
|
| Approve(ConnectionId, SessionId, DocumentId, String, String) |
Creates a new revision of the document that will act as the new currently published version of the document.
The current published content will be transferred to document history.
Documents that are of the File type cannot be approved using this method.
This methods supports anonymous callers.
|
| Approve(ConnectionId, SessionId, DocumentId, String, String, DateTime) |
Creates a new revision of the document that will act as the new currently published version of the document.
The current published content will be transferred to document history.
Documents that are of the File type cannot be approved using this method.
This methods supports anonymous callers.
|
| CheckAllowedBinaryDocument |
Checks whether a file can be uploaded to Content Studio.
|
| CheckIn(ConnectionId, SessionId, DocumentId) |
Checks in a document that is currently checked out.
This methods supports anonymous callers.
|
| CheckIn(ConnectionId, SessionId, DocumentId, Boolean) |
Checks in a document that is currently checked out.
This methods supports anonymous callers.
|
| CheckIn(ConnectionId, SessionId, String, Int32, String) |
Checks in a document that is currently checked out.
This methods supports anonymous callers.
|
| CheckOut(ConnectionId, SessionId, DocumentId) |
Checks out a document for editing.
This methods supports anonymous callers.
|
| CheckOut(ConnectionId, SessionId, DocumentId, Boolean) |
Checks out a document for editing.
This methods supports anonymous callers.
|
| CheckOut(ConnectionId, SessionId, String, Int32, String) |
Checks out a document for editing.
This methods supports anonymous callers.
|
| CheckOut(ConnectionId, SessionId, String, Boolean, Int32, String) |
Checks out a document for editing.
This methods supports anonymous callers.
|
| Create(ConnectionId, SessionId, String, String, Int32, String) |
Creates a new document. The document cannot be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| Create(ConnectionId, SessionId, DocumentId, CategoryId, DocumentId, Int32, String, Object, Object, Object, String, String, String, String, String, String, String, String, String, String, String, String) |
Creates a new document. The document cannot be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| Create(ConnectionId, SessionId, DocumentId, CategoryId, DocumentId, Int32, String, NullableBoolean, NullableDateTime, NullableDateTime, String, String, String, String, String, String, String, String, String, String, String, String, String) |
Creates a new document. The document cannot be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateBinary(ConnectionId, SessionId, String, String, Int32, String) |
Creates a new binary document. The document can only be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateBinary(ConnectionId, SessionId, DocumentId, Int32, CategoryId, String, String, Object, Object, Object, String, String, String, String, String, String, String, String, Int32, String) |
Creates a new binary document. The document can only be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateBinary(ConnectionId, SessionId, DocumentId, Int32, CategoryId, String, String, Object, Object, Object, String, String, Byte, String, String, String, String, String, Int32, String, String) |
Creates a new binary document. The document can only be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateBinary(ConnectionId, SessionId, DocumentId, Int32, CategoryId, String, String, Object, Object, Object, String, String, String, String, String, String, String, String, Int32, String, String) |
Creates a new binary document. The document can only be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateDocument(ConnectionId, SessionId, String, String, Int32, String) |
Creates a new document. This method exists only for the Content Studio copying functionality and should be used for special purposes only.
The document cannot be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateDocument(ConnectionId, SessionId, DocumentId, CategoryId, DocumentId, Int32, String, Object, Object, Object, String, String, String, String, String) |
Creates a new document without content.
This method exists only for the Content Studio copying functionality and should be used for special purposes only.
The document cannot be created in a category for binary documents (uploaded files).
This methods supports anonymous callers.
|
| CreateObjRef | (Inherited from MarshalByRefObject.) |
| Delete(ConnectionId, SessionId, DocumentId, Boolean, Boolean) |
Deletes a document permanently or places it in the Recycling bin. If a document is in the Recycling bin this method deletes the document permanently.
This methods supports anonymous callers.
|
| Delete(ConnectionId, SessionId, String, Int32, String) |
Deletes a document permanently or places it in the Recycling bin. If a document is in the Recycling bin this method deletes the document permanently.
This methods supports anonymous callers.
|
| Equals | (Inherited from Object.) |
| ExistsUploadedFile |
Tests if a binary file exists in a category. This method can be called by upload code before any content is uploaded into Content Studio temp direcory.
The caller can test if there is a file with this name uploaded in the category and ask the user if it should be overwritten or be given another name.
This methods supports anonymous callers.
|
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetLifetimeService | (Inherited from MarshalByRefObject.) |
| GetType | (Inherited from Object.) |
| InitializeLifetimeService | (Inherited from MarshalByRefObject.) |
| MemberwiseClone | (Inherited from Object.) |
| MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
| MoveDocumentInHierarchy(ConnectionId, SessionId, DocumentId, DocumentId) |
Moves a document within a document hierarchy or inserts it into a document hierarchy and places the document directly before the target.
The target document cannot be any of the document's children.
|
| MoveDocumentInHierarchy(ConnectionId, SessionId, DocumentId, DocumentId, Boolean) |
Moves a document within a document hierarchy or inserts it into a document hierarchy.
This method can either change the order within the same level or move the document to another level.
Parent documents cannot be moved to one of its children.
|
| MoveDocumentInHierarchy(ConnectionId, SessionId, String, Int32, String) |
Moves a document within a document hierarchy. This method can either change the order within the same level or move the document to another level. Parent documents cannot be moved to one of its children.
|
| Relocate |
Relocates the specified document from its current category to a another category of the same type or a compatible category type.
|
| RemoveFromFavourites(ConnectionId, SessionId, DocumentId) |
Removes a document from the list of favorite documents.
|
| RemoveFromFavourites(ConnectionId, SessionId, String, Int32, String) |
Removes a document from the list of favorite documents.
|
| Rename |
Changes the file name of a document.
|
| Save(ConnectionId, SessionId, String, String, Int32, String) |
Saves an existing document. The document cannot be a binary document (uploaded file).
This methods supports anonymous callers.
|
| Save(ConnectionId, SessionId, DocumentId, String, Object, Object, Object, String, String, String, String, String, String, String, String, String, String, String) |
Saves an existing document. The document cannot be a binary document (uploaded file).
This methods supports anonymous callers.
|
| Save(ConnectionId, SessionId, DocumentId, String, NullableBoolean, NullableDateTime, NullableDateTime, String, String, String, String, String, String, String, String, String, String, String, String) |
Saves an existing document. The document cannot be a binary document (uploaded file).
This methods supports anonymous callers.
|
| SaveBinary(ConnectionId, SessionId, String, String, Int32, String) |
Saves an existing binary document. The document cannot be a regular document.
This methods supports anonymous callers.
|
| SaveBinary(ConnectionId, SessionId, DocumentId, Object, Object, Object, String, String, String, String, String, String, String, String, Int32, Boolean, String) |
Saves an existing binary document. The document cannot be a regular document.
This methods supports anonymous callers.
|
| SaveBinary(ConnectionId, SessionId, DocumentId, Object, Object, Object, String, String, String, String, String, String, String, String, Int32, Boolean, String, String) |
Saves an existing binary document. The document cannot be a regular document.
This methods supports anonymous callers.
|
| SaveBinary(ConnectionId, SessionId, Int32, Object, Object, Object, String, String, Byte, String, String, String, String, String, Int32, Boolean, String, String) |
Saves an existing binary document. The document cannot be a regular document.
This methods supports anonymous callers.
|
| ToString | (Inherited from Object.) |
| Undelete(ConnectionId, SessionId, DocumentId) |
Restores a document that is in the recycling bin. If the document is not in the recycling bin an error occurs.
|
| Undelete(ConnectionId, SessionId, DocumentId, CategoryId) |
Restores a document that is in the recycling bin to specific category. If the document is not in the recycling bin an error occurs.
|
| Undelete(ConnectionId, SessionId, String, Int32, String) |
Restores a document that is in the recycling bin. If the document is not in the recycling bin an error occurs.
|
Fields
| Name | Description | |
|---|---|---|
  | MAX_BODYPROPERTIES_SIZE |
Indicates the maximum allowed size for a the body properties data.
|
| MAX_CONTENTTYPE_SIZE |
Indicates the maximum size for the document content type data.
|
| MAX_DOCUMENTNAME_SIZE |
Indicates the maximum size for the document name data.
|
| MAX_FILE_EXTENSION_SIZE |
Indicates the maximum size for the document file extension data.
|
| MAX_FILE_NAME_SIZE |
Indicates the maximum size for the document file name data.
|
 | MAX_FILE_PATH_NAME_SIZE |
Indicates the maximum size for the document path file name data.
|
| MAX_KEYWORD_SIZE |
The maximum length of the keywords field.
|
| MAX_MARKING_SIZE |
Indicates the maximum size for the document marking data.
|
| MAX_MENU_DATA_SIZE |
Indicates the maximum size for the document menu data.
|
| MAX_MENU_TARGET_SIZE |
Indicates the maximum size for the document menu target data.
|
| MAX_MENU_URL_SIZE |
Indicates the maximum size for the document menu url data.
|
Remarks
See Also