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

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

This class contains methods for reading documents and list of documents.
Inheritance Hierarchy

SystemObject
  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

public class DocumentReader : DocumentBase

The DocumentReader type exposes the following members.

Constructors

  NameDescription
Public methodDocumentReader
Initializes a new instance of the DocumentReader class
Top
Methods

  NameDescription
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetApprovedDocumentInformation
Returns information about a document that can be obtained by a caller that only has the BROWSE permission on the document.
Public methodGetASByName(ConnectionId, SessionId, String)
Reads data for an Active Scripting component using its name.
Public methodGetASByName(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.

Note Note
This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.
Public methodGetBinaryContent(ConnectionId, SessionId, DocumentId)
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
Public methodGetBinaryContent(ConnectionId, SessionId, DocumentId, Int32)
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
Public methodGetBinaryContent(ConnectionId, SessionId, String, Int32, String)
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
Public methodGetBinaryContentAsByteArray
Gets the binary content as byte array.
Public methodGetChildDocuments(ConnectionId, SessionId, DocumentId, Int32)
Gets all child documents for a certain document.
Public methodGetChildDocuments(ConnectionId, SessionId, String, Int32, String)
Gets all child documents for a certain document.
Public methodGetChildDocumentsTreeReverse(ConnectionId, SessionId, DocumentId, Int32)
Returns a parent-child chain from a certain document up to the ultimate parent document.
Public methodGetChildDocumentsTreeReverse(ConnectionId, SessionId, DocumentId, Boolean, Int32)
Returns a parent-child chain from a certain document up to the ultimate parent document.
Public methodGetChildDocumentsTreeReverse(ConnectionId, SessionId, String, Int32, String)
Returns a parent-child chain from a certain document up to the ultimate parent document.
Public methodGetDetails(ConnectionId, SessionId, DocumentId)
Gets detailed data for a Content Studio document including its source code content.
Public methodGetDetails(ConnectionId, SessionId, DocumentId, Int32)
Gets detailed data for a Content Studio document including its source code content.
Public methodGetDetails(ConnectionId, SessionId, String, Int32, String)
Gets detailed data for a Content Studio document including its source code content.
Public methodGetDocumentFromRelativeURL(ConnectionId, SessionId, String) Obsolete.
Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
Public methodGetDocumentFromRelativeURL(ConnectionId, SessionId, String, Int32, String) Obsolete.
Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
Public methodGetDocumentIdentifierFromRelativeURL
Obtains the identifier for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
Public methodGetDocumentsInCategory(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.
Public methodGetDocumentsInCategory(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.
Public methodGetDocumentsInCategory(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.
Public methodGetDocumentsInCategory(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.
Public methodGetDocumentsInRecyclingBin
Gets a list of documents in the recycling bin.
Public methodGetDocumentsInRecyclingBinXml
Gets a list of documents in the recycling bin as xml that can be used by the document list in Content Studio.
Public methodGetDocumentsSpecialList(ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String)
Returns a special list of documents.
Public methodGetDocumentsSpecialList(ConnectionId, SessionId, DocumentReaderDocumentSpecialList, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, Int32, Int32, Int32)
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
Public methodGetDocumentsSpecialList(ConnectionId, SessionId, DocumentReaderDocumentSpecialList, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, String, Int32, Int32, Int32)
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
Public methodGetDocumentType
Returns information about the type of a Content Studio document.
Public methodGetDocumentVersionInformation
Gets the version information for the draft content of a document
Public methodGetExtendedContentProperties
Public methodGetHashCode (Inherited from Object.)
Public methodGetLevelInfo
Gets information about the level and ordinal position for a document that is part of a document hierarchy.
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetProcessedImage
Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting
Public methodStatic memberGetProcessedImageOutsideRemoting
Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting
Public methodCode exampleGetProperties(ConnectionId, SessionId, DocumentId, String)
Returns selected properties of a Content Studio document.
Public methodCode exampleGetProperties(ConnectionId, SessionId, DocumentId, String, Int32)
Returns selected properties of a Content Studio document depending on the document version.
Public methodGetProperties(ConnectionId, SessionId, String, Int32, String)
Returns selected properties of a Content Studio document.
Public methodGetType (Inherited from Object.)
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Public methodStatic memberIsImageFormatSupportedForProcessing
Determines whether a file is an image and is supported for processing.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodMemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public methodRevisionProperties
Returns a collection of properties for a document versioning. No data fields such as ContentBinary or Keywords are returned with this call.
Public methodSearchDocuments(ConnectionId, SessionId, DocumentId, Int32)
Searches documents in Content Studio
Public methodSearchDocuments(ConnectionId, SessionId, String, Int32)
Searches documents in Content Studio
Public methodSearchDocuments(ConnectionId, SessionId, String, Boolean, Int32)
Searches documents in Content Studio
Public methodSearchDocuments(ConnectionId, SessionId, String, Int32, String)
Searches documents in Content Studio
Public methodToString (Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberMAX_ALLOWED_FILETYPES_SIZE
Defines the maximum size of the joined file extension members
Public fieldStatic memberMAX_SEARCH_CRITERIA
Defines the maximum size of the full-text search argument in the SearchDocuments method.
Public fieldStatic memberMAX_SEARCH_DOCUMENT_NAME
Defines the maximum size of the document name search argument in the SearchDocuments method.
Public fieldStatic memberMIN_SEARCHSTRING_SIZE
Defines the shortest allowed string that can be used as a search string in the SearchDocuments method.
Top
See Also

Reference