DocumentComponentSupportDocumentPublishedTreeReverse Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Returns a parent-child chain from a certain document up to its parent or specified document id. If the caller does not have permission to browse a document in the chain the process exists with the last browsable document found. This method is used by the Tree menu component.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string DocumentPublishedTreeReverse(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	DocumentId rootId,
	bool sortFromRoot,
	out int recordCount,
	DateTime dateCriteria


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: ContentStudio.DocumentDocumentId
The document to start from
Type: ContentStudio.DocumentDocumentId
A document that exists in the tree where the chain should end. If the root document does not exists, is zero or does not belong to the tree the traversing continues until the top root document.
Type: SystemBoolean
Indicates that the returned list should be sorted from the root to the last child rather that the opposite direction.
Type: SystemInt32
Returns the number of documents found in the tree
Type: SystemDateTime
A preview date to use to be able to examine the tree taking the publish status at a given time. Normally you pass MinValue to use the current status.

Return Value

Type: String
<document id="12" />
<!-- more documents can follow -->

CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission on the start document
CSInvalidSessionExceptionThe session is invalid
CSDocumentNotFoundExceptionThe document indicated by the DocumentID parameter could not be found
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

BROWSE permission on the each one of the documents in the chain is required. This call supports anonymous users.
See Also