SiteMapProvider.FindSiteMapNodeFromKey(String) Methode

Definition

Ruft ein SiteMapNode-Objekt auf Grundlage eines angegebenen Schlüssels ab.Retrieves a SiteMapNode object based on a specified key.

public:
 virtual System::Web::SiteMapNode ^ FindSiteMapNodeFromKey(System::String ^ key);
public virtual System.Web.SiteMapNode FindSiteMapNodeFromKey (string key);
abstract member FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode
override this.FindSiteMapNodeFromKey : string -> System.Web.SiteMapNode
Public Overridable Function FindSiteMapNodeFromKey (key As String) As SiteMapNode

Parameter

key
String

Ein Suchschlüssel, mit dem ein SiteMapNode erstellt wird.A lookup key with which a SiteMapNode is created.

Gibt zurück

Ein SiteMapNode, der die von key angegebene Seite darstellt. Andernfalls null, wenn kein entsprechender SiteMapNode gefunden wird oder wenn Einschränkungen aus Sicherheitsgründen aktiviert sind und der SiteMapNode für den aktuellen Benutzer nicht zurückgegeben werden kann.A SiteMapNode that represents the page identified by key; otherwise, null, if no corresponding SiteMapNode is found or if security trimming is enabled and the SiteMapNode cannot be returned for the current user. Die Standardeinstellung ist null.The default is null.

Hinweise

Die SiteMapProvider Implementierung gibt null in allen Fällen zurück.The SiteMapProvider implementation returns null in all cases. Klassen, die von der SiteMapProvider -Klasse abgeleitet werden FindSiteMapNodeFromKey , können die-Methode überschreiben, um Suchfunktionen auf Grundlage eines eindeutigen Schlüssels (anstelle einer URL, die FindSiteMapNode von der-Methode verwendet wird) bereitzustellen.Classes that derive from the SiteMapProvider class can override the FindSiteMapNodeFromKey method to provide lookup functionality based on a unique key (instead of a URL, which is used by the FindSiteMapNode method). Implementieren Sie FindSiteMapNodeFromKey die-Methode, wenn die Implementierung des Site SiteMapNode.Key Map-Anbieters SiteMapNode die-Eigenschaft eines-Objekts als primären Bezeichner in einer Site Übersichts Struktur verwendet.Implement the FindSiteMapNodeFromKey method if your site map provider implementation uses the SiteMapNode.Key property of a SiteMapNode object as a primary identifier in a site map structure.

Die StaticSiteMapProvider -Klasse stellt eine-Implementierung bereit, die die Suche nach Site Übersichts Knoten behandelt, die keine URL definieren.The StaticSiteMapProvider class provides an implementation that handles searching for site map nodes that do not define a URL.

Die XmlSiteMapProvider -Klasse, bei der es sich um den Standard-Site Übersichts Anbieter für ASP.net handelt SiteMapNode , verwendet die URL eines als Schlüssel in den verschiedenen Auflistungen, die von den Klassen verwaltet werden.The XmlSiteMapProvider class, which is the default site map provider for ASP.NET, uses the URL of a SiteMapNode as a key in the various collections that the classes maintain. Wenn ein Knoten eine URL bereitstellt, muss er daher innerhalb des Bereichs des Site Übersichts Anbieters eindeutig sein.Therefore, if a node provides a URL, it must be unique within the scope of the site map provider. Wenn keine URL angegeben wird, wird ein eindeutiger Bezeichner generiert, SiteMapNodeum die zu identifizieren.If no URL is provided, a unique identifier is generated to identify the SiteMapNode.

Gilt für:

Siehe auch