IEditableSiteMapProvider.GetMenuState - Méthode

Article
05/12/2015

Retourne la sous-arborescence d'enfants de nœuds du nœud de démarrage spécifié, tronquée à la profondeur maximale spécifiée. En règle générale, le nœud de démarrage sera SiteMapProvider.RootNode ou SiteMapProvider.CurrentNode, selon la configuration.

Espace de noms : Microsoft.SharePoint.Navigation
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Function GetMenuState ( _
    startingNodeKey As String, _
    maximumDepth As Integer, _
    customProperties As StringCollection _
) As EditableAspMenuState
'Utilisation
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
)

Paramètres

startingNodeKey
Type : System.String

Ceci est un identificateur utilisé avec SiteMapProvider.FindSiteMapNodeFromKey() ou IHierarchicalDataSource.GetHierarchicalView() pour récupérer le nœud de démarrage. Il est identique à celle exposée par SiteMapNode.Key, IHierarchyData.Path et EditableAspMenuNode.Key.

maximumDepth
Type : System.Int32

Le nombre maximal de niveaux d'arborescence à extraire, en fonction de la sémantique de MenuItem.Depth de AspMenu. Si maximumDepth = 0, uniquement la première ligne d'éléments est retournée. Si vous maximumDepth=Int32.MaxValue, puis tous les éléments sont retournés.

customProperties
Type : System.Collections.Specialized.StringCollection

Certains SiteMapProviders avoir la possibilité de stocker des propriétés personnalisées supplémentaires correspondant à un SiteMapNode. L'implémentation des propriétés personnalisées dans une classe dérivée est facultative. Si le SiteMapProvider prend en charge cette option, une liste de propriétés personnalisées peut être demandée en plus des valeurs fortement typées dans la EditableAspMenuNode. Propriétés personnalisées seront renvoyées comme un sac de propriétés de EditableAspMenuNode.CustomProperties

Valeur renvoyée

Type : Microsoft.SharePoint.Navigation.EditableAspMenuState

Voir aussi

Référence

IEditableSiteMapProvider interface

IEditableSiteMapProvider - Membres

Microsoft.SharePoint.Navigation - Espace de noms

Partager via