Compartir a través de

del método IEditableSiteMapProvider.GetMenuState

  • Artículo

Devuelve el subárbol de secundarios los nodos del nodo inicial especificado, truncado a la profundidad máxima especificada. En general, el nodo de inicio será SiteMapProvider.RootNode o SiteMapProvider.CurrentNode, según la configuración.

Espacio de nombres:  Microsoft.SharePoint.Navigation
Ensamblado:  Microsoft.SharePoint (en Microsoft.SharePoint.dll)

Sintaxis

'Declaración
Function GetMenuState ( _
    startingNodeKey As String, _
    maximumDepth As Integer, _
    customProperties As StringCollection _
) As EditableAspMenuState
'Uso
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
)

Parámetros

  • startingNodeKey
    Tipo: System.String

    Se trata de un identificador que se utiliza con SiteMapProvider.FindSiteMapNodeFromKey() o IHierarchicalDataSource.GetHierarchicalView() para recuperar el nodo de inicio. Es la misma clave expuesta por SiteMapNode.Key, IHierarchyData.Path y EditableAspMenuNode.Key.

  • maximumDepth
    Tipo: System.Int32

    El número máximo de niveles de árbol para recuperar, de acuerdo con la semántica de MenuItem.Depth del AspMenu. Si maximumDepth = 0, a continuación, se devuelve sólo la primera fila de elementos. Si se devuelven maximumDepth=Int32.MaxValue y, a continuación, todos los elementos.

  • customProperties
    Tipo: System.Collections.Specialized.StringCollection

    Algunos SiteMapProviders tienen la posibilidad de almacenar propiedades personalizadas adicionales para SiteMapNode. Implementación de las propiedades personalizadas en una clase derivada es opcional. Si admite SiteMapProvider, una lista de propiedades personalizadas se puede solicitarse además de los valores fuertemente tipados en el EditableAspMenuNode. Las propiedades personalizadas se devolverán como un contenedor de propiedades de EditableAspMenuNode.CustomProperties

Valor devuelto

Tipo: Microsoft.SharePoint.Navigation.EditableAspMenuState

Vea también

Referencia

interfaz IEditableSiteMapProvider

Miembros IEditableSiteMapProvider

Espacio de nombres Microsoft.SharePoint.Navigation