MenuCreatorGetXmlMenu Method (ConnectionId, SessionId, DocumentId, DocumentId, DateTime, Boolean, Boolean) 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)

public string GetXmlMenu(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	DocumentId currentDocumentId,
	DateTime dateCriteria,
	bool performAccessCheck,
	bool usePublishStatus


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 document that acts as the menu's root document. All member documents in the menu must be child documents of this root document.
Type: ContentStudio.DocumentDocumentId
This parameter is not supported for CS running on SQL Server 2000. If this parameter is greater than 0 this method will only return the relevant part of the document hierarchy. E.g. The document itself, its immediate children. Furthermore, a check is performed to see which of those documents that have children themselves. By supplying this parameter, the performance can increase several times depending how large the hierarchy is. This parameter is only useful when rendering menus that has a tree lookalike style.
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.
Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. This method does not return any sensitive information, therefore it is possible to turn off the access check for each document in the hierarchy to increase the performance.
Type: SystemBoolean
This parameter is not supported for CS running on SQL Server 2000. By setting this parameter to false publish date, archivedate and published will be ignored to increase performance.

Return Value

Type: String
Xml in an hierarchical structure This method returns the following xml document syntax
    <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="" />

SqlExceptionAn 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.
See Also