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

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

Gets information about the level and ordinal position for a document that is part of a document hierarchy.

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

public string GetLevelInfo(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	bool includeRoot


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
A value that identifies the document whose level info should be displayed.
Type: SystemBoolean
Determines whether the root level should be included in the output or not.

Return Value

Type: String
Xml with the following syntax
  <documentname>My document</documentname>
  <leveltext>The text</leveltext>
  <level no="0" value="0" />
  <level no="1" value="4" />
  <level no="2" value="1" />
  <level no="3" value="1" />
  <level no="4" value="1" />
  <level no="5" value="2" />
  <!-- more level elements can follow -->
Returned elementsIndicates the outcome of the call, value is always 0
root/statustextStringIndicates the outcome of the call, value is always "Success"
root/documentnameStringThe document name
root/leveltextStringcontains the textual version of the individual level data members. See remarks below.
root/levelDefines a single level information node
root/level@noInteger The level of the document where 0 is the root level. The highest level will represent the position and level of the document itself. Level 0 will only be returned if includeRoot is true.
root/level@valueIntegerThe ordinal position within the level. In the example above the document will have position 2 on level 5 with a parent document on level 4 with position 1. 1 represents the first position.

The leveltext value contains the textual version of the individual level data members. The document sample return value above will have the level info

The graphical representation of the sample return value above might look like this.

                | +Document1:1
                | +Document1:2
                | +Document1:3
                | -Document1:4
                   | -Document2:1
                       | -Document3:1
                           | -Document4:1
                               | +Document5:1
                               | -My document
                | +Document1:5


CSInvalidSessionExceptionThe session is invalid
CSPermissionDeniedExceptionPermission denied
CSDocumentNotFoundExceptionThe document does not exist
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

BROWSE permission is required on the document. This call supports anonymous logins.
See Also