SPXmlContentMapProvider.FindSiteMapNodeFromKey - Méthode

Article
05/12/2015

Récupère un objet SiteMapNode selon une clé spécifiée.

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

Syntaxe

'Déclaration
Public Overrides Function FindSiteMapNodeFromKey ( _
    key As String _
) As SiteMapNode
'Utilisation
Dim instance As SPXmlContentMapProvider
Dim key As String
Dim returnValue As SiteMapNode

returnValue = instance.FindSiteMapNodeFromKey(key)

public override SiteMapNode FindSiteMapNodeFromKey(
    string key
)

Paramètres

key
Type : System.String

Clé de recherche avec laquelle un SiteMapNode est créé.

Valeur renvoyée

Type : System.Web.SiteMapNode
SiteMapNode qui représente la page identifiée par clé. Si aucun correspondant SiteMapNode est trouvé, une référence de une référence Null (Rien dans Visual Basic) (Nothing dans Visual Basic) est retournée. La valeur par défaut est une référence de une référence Null (Rien dans Visual Basic) (Nothing dans Visual Basic).

Exceptions

Exception	Condition
ArgumentNullException	Une valeur requise String est une référence Null (Rien dans Visual Basic).

Remarques

Les classes qui dérivent de la classe SiteMapProvider peuvent substituer la méthode FindSiteMapNodeFromKey pour fournir une fonctionnalité de recherche fondée sur une clé unique. Cette méthode doit être implémentée lorsqu'un fournisseur de plan de site utilise la propriété Key en tant qu'identificateur principal au sein d'une structure de plan de site.