MenuCreator.GetXmlMenu Method (ConnectionId, SessionId, DocumentId, DateTime)

MenuCreatorGetXmlMenu Method (ConnectionId, SessionId, DocumentId, DateTime)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns an hierarchical Xml document that can act as the source for a menu. The standard Content Studio menu components uses this source when rendering their interface.

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

Syntax

Copy

public string GetXmlMenu(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	DateTime dateCriteria
)

Public Function GetXmlMenu ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	dateCriteria As DateTime
) 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 that acts as the menu's root document. All member documents in the menu must be child documents of this root document.
dateCriteria: Type: SystemDateTime
A datevalue 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.

Return Value

Type: String
Xml in an hierarchical structure This method returns the following xml document syntax

Copy

<root>
    <status>0</status>
    <statustext>Success</statustext>
    <document id="1146" cid="131" parentid="1146" name=":root:" level="1" href="">
        <data url="" data="" target="" />
        <document id="1022" cid="131" parentid="1146" name="Startsida" level="2" href="">
            <data url="" data="" target="" />
            <document id="1041" cid="131" parentid="1022" name="Nyheter" level="3" href="">
                <data url="" data="" target="" />
            </document>
        </document>
    </document>
</root>

Exceptions

Exception	Condition
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

All authenticated users and the anonymous use can call this method. However, only the document that the caller can BROWSE is returned.

Reference

MenuCreator Class

GetXmlMenu Overload

ContentStudio.Document.Menu Namespace