Content Studio Web Content Management System
SystemObject
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudio.DocumentDocumentSystemBase
ContentStudio.DocumentDocumentBase
ContentStudio.DocumentDocumentReader
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This class contains methods for reading documents and list of documents.
Inheritance Hierarchy
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudio.DocumentDocumentSystemBase
ContentStudio.DocumentDocumentBase
ContentStudio.DocumentDocumentReader
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The DocumentReader type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DocumentReader | Initializes a new instance of the DocumentReader class |
Methods
Name | Description | |||
---|---|---|---|---|
CreateObjRef | (Inherited from MarshalByRefObject.) | |||
Equals | (Inherited from Object.) | |||
Finalize | (Inherited from Object.) | |||
GetApprovedDocumentInformation |
Returns information about a document that can be obtained by a caller that only has the BROWSE permission on the document.
| |||
GetASByName(ConnectionId, SessionId, String) |
Reads data for an Active Scripting component using its name.
| |||
GetASByName(ConnectionId, SessionId, String, Int32, String) |
Reads data for an Active Scripting component using its name.
Remarks If more than one component exists with the same name only one of the will be returned.
| |||
GetBinaryContent(ConnectionId, SessionId, DocumentId) |
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
| |||
GetBinaryContent(ConnectionId, SessionId, DocumentId, Int32) |
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
| |||
GetBinaryContent(ConnectionId, SessionId, String, Int32, String) |
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
| |||
GetBinaryContentAsByteArray |
Gets the binary content as byte array.
| |||
GetChildDocuments(ConnectionId, SessionId, DocumentId, Int32) |
Gets all child documents for a certain document.
| |||
GetChildDocuments(ConnectionId, SessionId, String, Int32, String) |
Gets all child documents for a certain document.
| |||
GetChildDocumentsTreeReverse(ConnectionId, SessionId, DocumentId, Int32) |
Returns a parent-child chain from a certain document up to the ultimate parent document.
| |||
GetChildDocumentsTreeReverse(ConnectionId, SessionId, DocumentId, Boolean, Int32) |
Returns a parent-child chain from a certain document up to the ultimate parent document.
| |||
GetChildDocumentsTreeReverse(ConnectionId, SessionId, String, Int32, String) |
Returns a parent-child chain from a certain document up to the ultimate parent document.
| |||
GetDetails(ConnectionId, SessionId, DocumentId) |
Gets detailed data for a Content Studio document including its source code content.
| |||
GetDetails(ConnectionId, SessionId, DocumentId, Int32) |
Gets detailed data for a Content Studio document including its source code content.
| |||
GetDetails(ConnectionId, SessionId, String, Int32, String) |
Gets detailed data for a Content Studio document including its source code content.
| |||
GetDocumentFromRelativeURL(ConnectionId, SessionId, String) | Obsolete.
Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
| |||
GetDocumentFromRelativeURL(ConnectionId, SessionId, String, Int32, String) | Obsolete.
Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
| |||
GetDocumentIdentifierFromRelativeURL |
Obtains the identifier for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
| |||
GetDocumentsInCategory(ConnectionId, SessionId, String, Int32, String) |
Returns a pageable list of documents that exists in a category. It is possible to apply filters to this list.
| |||
GetDocumentsInCategory(ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String) |
Returns a pageable list of documents that exists in a category. It is possible to apply filters to this list.
| |||
GetDocumentsInCategory(ConnectionId, SessionId, DocumentReaderDocumentsInCategoryReturnLevel, CategoryId, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, Int32, Int32, Int32) |
Returns a pageable list of documents that exists in a category. It is possible to apply filters to this list.
| |||
GetDocumentsInCategory(ConnectionId, SessionId, DocumentReaderDocumentsInCategoryReturnLevel, CategoryId, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, String, Int32, Int32, Int32) |
Returns a pageable list of documents that exists in a category. It is possible to apply filters to this list.
| |||
GetDocumentsInRecyclingBin |
Gets a list of documents in the recycling bin.
| |||
GetDocumentsInRecyclingBinXml |
Gets a list of documents in the recycling bin as xml that can be used by the
document list in Content Studio.
| |||
GetDocumentsSpecialList(ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String) |
Returns a special list of documents.
| |||
GetDocumentsSpecialList(ConnectionId, SessionId, DocumentReaderDocumentSpecialList, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, Int32, Int32, Int32) |
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
| |||
GetDocumentsSpecialList(ConnectionId, SessionId, DocumentReaderDocumentSpecialList, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, String, Int32, Int32, Int32) |
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
| |||
GetDocumentType |
Returns information about the type of a Content Studio document.
| |||
GetDocumentVersionInformation |
Gets the version information for the draft content of a document
| |||
GetExtendedContentProperties | ||||
GetHashCode | (Inherited from Object.) | |||
GetLevelInfo |
Gets information about the level and ordinal position for a document that is part of a document hierarchy.
| |||
GetLifetimeService | (Inherited from MarshalByRefObject.) | |||
GetProcessedImage |
Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting
| |||
GetProcessedImageOutsideRemoting |
Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting
| |||
GetProperties(ConnectionId, SessionId, DocumentId, String) |
Returns selected properties of a Content Studio document.
| |||
GetProperties(ConnectionId, SessionId, DocumentId, String, Int32) |
Returns selected properties of a Content Studio document depending on the document version.
| |||
GetProperties(ConnectionId, SessionId, String, Int32, String) |
Returns selected properties of a Content Studio document.
| |||
GetType | (Inherited from Object.) | |||
InitializeLifetimeService | (Inherited from MarshalByRefObject.) | |||
IsImageFormatSupportedForProcessing |
Determines whether a file is an image and is supported for processing.
| |||
MemberwiseClone | (Inherited from Object.) | |||
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) | |||
RevisionProperties |
Returns a collection of properties for a document versioning. No data fields such as ContentBinary or Keywords are returned with this call.
| |||
SearchDocuments(ConnectionId, SessionId, DocumentId, Int32) |
Searches documents in Content Studio
| |||
SearchDocuments(ConnectionId, SessionId, String, Int32) |
Searches documents in Content Studio
| |||
SearchDocuments(ConnectionId, SessionId, String, Boolean, Int32) |
Searches documents in Content Studio
| |||
SearchDocuments(ConnectionId, SessionId, String, Int32, String) |
Searches documents in Content Studio
| |||
ToString | (Inherited from Object.) |
Fields
Name | Description | |
---|---|---|
MAX_ALLOWED_FILETYPES_SIZE |
Defines the maximum size of the joined file extension members
| |
MAX_SEARCH_CRITERIA |
Defines the maximum size of the full-text search argument in the SearchDocuments method.
| |
MAX_SEARCH_DOCUMENT_NAME |
Defines the maximum size of the document name search argument in the SearchDocuments method.
| |
MIN_SEARCHSTRING_SIZE |
Defines the shortest allowed string that can be used as a search string in the SearchDocuments method.
|
See Also