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

public string DocumentParentTree(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	DateTime dateCriteria,
	bool sortAsc
)

Public Function DocumentParentTree ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	dateCriteria As DateTime,
	sortAsc As Boolean
) As String

Parameters

connectionId

Type: ContentStudioConnectionId
A value that identifies the web site

sessionId

Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).

documentId

Type: ContentStudio.DocumentDocumentId
A document whose ancestors should be listed.

dateCriteria

Type: SystemDateTime
A DateTime that is compared with the publish date of the listed documents. Can be used when previewing documents in time. Pass MinValue to use the current date.

sortAsc

Type: SystemBoolean
Set to true to have the list sorted from the document to its root parent, false to start with the root document in the tree.

Return Value

This method returns the following xml document syntax
Starting with version 5.3 this method also returns the attribute userdata

<root>
  <status>0</status>
  <statustext>Success</statustext>
  <document documentid="1146" parentid="1146" documentname="Name" userdata="data"/>
  <document documentid="1022" parentid="1146" documentname="Name" userdata="data"/>
  <!-- more document element can follow -->
</root>

The user data attribute contains the user data contained with the document. This data can be specified by the document editor and can be used to tag the menu item with useful data such as an image Url or an alternate text. The source of this data is the ElementImage database field in the dbo.tbl_modules_content table.

Reference