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

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

The DocumentReader type exposes the following members.

Methods

  Name Description
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetApprovedDocumentInformation
Returns information about a document that can be obtained by a caller that only has the BROWSE permission on the document.
Public method GetASByName(ConnectionId, SessionId, String)
Reads data for an Active Scripting component using its name.
Public method 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.

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 method GetBinaryContent(ConnectionId, SessionId, DocumentId)
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
Public method GetBinaryContent(ConnectionId, SessionId, DocumentId, Int32)
Returns the content together with its size and type of a document. The content returned is Base64 binary data.
Public method 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.
Public method GetBinaryContentAsByteArray
Gets the binary content as byte array.
Public method GetChildDocuments(ConnectionId, SessionId, DocumentId, Int32)
Gets all child documents for a certain document.
Public method GetChildDocuments(ConnectionId, SessionId, String, Int32, String)
Gets all child documents for a certain document.
Public method GetChildDocumentsTreeReverse(ConnectionId, SessionId, DocumentId, Int32)
Returns a parent-child chain from a certain document up to the ultimate parent document.
Public method GetChildDocumentsTreeReverse(ConnectionId, SessionId, DocumentId, Boolean, Int32)
Returns a parent-child chain from a certain document up to the ultimate parent document.
Public method GetChildDocumentsTreeReverse(ConnectionId, SessionId, String, Int32, String)
Returns a parent-child chain from a certain document up to the ultimate parent document.
Public method GetDetails(ConnectionId, SessionId, DocumentId)
Gets detailed data for a Content Studio document including its source code content.
Public method GetDetails(ConnectionId, SessionId, DocumentId, Int32)
Gets detailed data for a Content Studio document including its source code content.
Public method GetDetails(ConnectionId, SessionId, String, Int32, String)
Gets detailed data for a Content Studio document including its source code content.
Public method GetDocumentFromRelativeURL(ConnectionId, SessionId, String) Obsolete.
Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
Public method GetDocumentFromRelativeURL(ConnectionId, SessionId, String, Int32, String) Obsolete.
Obtains the identifier, as Xml, for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
Public method GetDocumentIdentifierFromRelativeURL
Obtains the identifier for a document if you know its relative URL (UNIT/CATEGORY/FILENAME).
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method GetDocumentsInRecyclingBin
Gets a list of documents in the recycling bin.
Public method GetDocumentsInRecyclingBinXml
Gets a list of documents in the recycling bin as xml that can be used by the document list in Content Studio.
Public method GetDocumentsSpecialList(ConnectionId, SessionId, String, Int32, Int32, Int32, Int32, Int32, String)
Returns a special list of documents.
Public method GetDocumentsSpecialList(ConnectionId, SessionId, DocumentReaderDocumentSpecialList, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, Int32, Int32, Int32)
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
Public method GetDocumentsSpecialList(ConnectionId, SessionId, DocumentReaderDocumentSpecialList, DocumentId, DocumentReaderDocumentListFilters, DocumentReaderDocumentListSortOrder, Int32, String, Int32, Int32, Int32)
Returns a special list of documents such as MyOwnDocuments or MyCheckedOutDocuments.
Public method GetDocumentType
Returns information about the type of a Content Studio document.
Public method GetDocumentVersionInformation
Gets the version information for the draft content of a document
Public method GetExtendedContentProperties
Public method GetHashCode (Inherited from Object.)
Public method GetLevelInfo
Gets information about the level and ordinal position for a document that is part of a document hierarchy.
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetProcessedImage
Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting
Public method Static member GetProcessedImageOutsideRemoting
Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting
Public method Code example GetProperties(ConnectionId, SessionId, DocumentId, String)
Returns selected properties of a Content Studio document.
Public method Code example GetProperties(ConnectionId, SessionId, DocumentId, String, Int32)
Returns selected properties of a Content Studio document depending on the document version.
Public method GetProperties(ConnectionId, SessionId, String, Int32, String)
Returns selected properties of a Content Studio document.
Public method GetType (Inherited from Object.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Public method Static member IsImageFormatSupportedForProcessing
Determines whether a file is an image and is supported for processing.
Protected method MemberwiseClone (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method RevisionProperties
Returns a collection of properties for a document versioning. No data fields such as ContentBinary or Keywords are returned with this call.
Public method SearchDocuments(ConnectionId, SessionId, DocumentId, Int32)
Searches documents in Content Studio
Public method SearchDocuments(ConnectionId, SessionId, String, Int32)
Searches documents in Content Studio
Public method SearchDocuments(ConnectionId, SessionId, String, Boolean, Int32)
Searches documents in Content Studio
Public method SearchDocuments(ConnectionId, SessionId, String, Int32, String)
Searches documents in Content Studio
Public method ToString (Inherited from Object.)
Top
See Also

Reference