IEditableSiteMapProvider.GetMenuState method

  • Article

Returns the subtree of child nodes of the specified starting node, truncated to the specified maximum depth. In general, the starting node will be either SiteMapProvider.RootNode or SiteMapProvider.CurrentNode, depending on the configuration.

Namespace:  Microsoft.SharePoint.Navigation
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Function GetMenuState ( _
    startingNodeKey As String, _
    maximumDepth As Integer, _
    customProperties As StringCollection _
) As EditableAspMenuState
'Usage
Dim instance As IEditableSiteMapProvider
Dim startingNodeKey As String
Dim maximumDepth As Integer
Dim customProperties As StringCollection
Dim returnValue As EditableAspMenuState

returnValue = instance.GetMenuState(startingNodeKey, _
    maximumDepth, customProperties)

EditableAspMenuState GetMenuState(
    string startingNodeKey,
    int maximumDepth,
    StringCollection customProperties
)

Parameters

  • startingNodeKey
    Type: System.String

    This is an identifier used with SiteMapProvider.FindSiteMapNodeFromKey() or IHierarchicalDataSource.GetHierarchicalView() to fetch the starting node. It is the same key exposed by SiteMapNode.Key, IHierarchyData.Path, and EditableAspMenuNode.Key.

  • maximumDepth
    Type: System.Int32

    The maximum number of tree levels to fetch, according to the semantics of AspMenu's MenuItem.Depth. If maximumDepth=0 then only the first row of items is returned. If maximumDepth=Int32.MaxValue, then all items are returned.

  • customProperties
    Type: System.Collections.Specialized.StringCollection

    Some SiteMapProviders have the possibility to store additional custom properties for a SiteMapNode. Implementing custom properties in a derived class is optional. If the SiteMapProvider supports this, then a list of custom properties can be requested in addition to the strongly typed values in the EditableAspMenuNode. Custom Properties will be returned as a property bag in EditableAspMenuNode.CustomProperties

Return value

Type: Microsoft.SharePoint.Navigation.EditableAspMenuState

See also

Reference

IEditableSiteMapProvider interface

IEditableSiteMapProvider members

Microsoft.SharePoint.Navigation namespace