MenuCreator Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This class contains methods that components that generates menus can use.
Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    ContentStudioCSBase
      ContentStudio.Document.MenuMenuCreator

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

public sealed class MenuCreator : CSBase

The MenuCreator type exposes the following members.

Constructors

  NameDescription
Public methodMenuCreator
Initializes a new instance of the MenuCreator class
Top
Methods

  NameDescription
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodDocumentParentTree(ConnectionId, SessionId, DocumentId, Boolean)
Returns a collection of ancestor documents for a document. This data is used as input for the InsertDocumentTreePath component or any other code that needs to create a bread-crumb path to a document.
Public methodDocumentParentTree(ConnectionId, SessionId, DocumentId, DateTime, Boolean)
Returns a collection of ancestor documents for a document. This data is used as input for the InsertDocumentTreePath component or any other code that needs to create a bread-crumb path to a document.
Public methodEquals (Inherited from Object.)
Public methodGetDocumentTree(ConnectionId, SessionId, DocumentId, Int32)
Returns a complete menu in a flat structure with parent menu and all its children. If no DateCriteria is supplied then only the currently valid menus are returned else the menus valid at the supplied date are returned. The "Insert simple menu" component uses this method as input
Public methodGetDocumentTree(ConnectionId, SessionId, DocumentId, DateTime, Int32)
Returns a complete menu in a flat structure with parent menu and all its children. If no DateCriteria is supplied then only the currently valid menus are returned else the menus valid at the supplied date are returned. The "Insert simple menu" component uses this method as input
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetType (Inherited from Object.)
Public methodGetWebTree(ConnectionId, SessionId, DocumentId, Boolean)
Returns a complete menu in a hierarchical structure with parent menu and all its children.
Public methodGetWebTree(ConnectionId, SessionId, DocumentId, DateTime, Boolean)
Returns a complete menu in a hierarchical structure with parent menu and all its children.
Public methodGetXmlMenu(ConnectionId, SessionId, DocumentId)
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.
Public methodGetXmlMenu(ConnectionId, SessionId, DocumentId, DateTime)
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.
Public methodGetXmlMenu(ConnectionId, SessionId, DocumentId, DocumentId, DateTime, Boolean, Boolean)
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.
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Public methodListChildren(ConnectionId, SessionId, DocumentId, DocumentId)
Returns a list of child documents to a document
Public methodListChildren(ConnectionId, SessionId, DocumentId, DateTime)
Returns a list of child documents to a document
Public methodListChildren(ConnectionId, SessionId, DocumentId, DocumentId, DateTime)
Returns a list of child documents to a document
Public methodListChildren(ConnectionId, SessionId, DocumentId, DocumentId, DateTime, MenuCreatorListChildrenSortOrder)
Returns a list of child documents to a document
Public methodToString (Inherited from Object.)
Top
See Also

Reference