SiteMapProvider.FindSiteMapNodeFromKey Method

Note: This method is new in the .NET Framework version 2.0.

Retrieves a SiteMapNode object based on a specified key.

Namespace: System.Web
Assembly: System.Web (in system.web.dll)

public virtual SiteMapNode FindSiteMapNodeFromKey (
	string key
public SiteMapNode FindSiteMapNodeFromKey (
	String key
public function FindSiteMapNodeFromKey (
	key : String
) : SiteMapNode



A lookup key with which a SiteMapNode is created.

Return Value

A SiteMapNode that represents the page identified by key; otherwise, a null reference (Nothing in Visual Basic), if no corresponding SiteMapNode is found or if security trimming is enabled and the SiteMapNode cannot be returned for the current user. The default is a null reference (Nothing in Visual Basic).

The SiteMapProvider implementation returns a null reference (Nothing in Visual Basic) in all cases. 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). 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.

The StaticSiteMapProvider class provides an implementation that handles searching for site map nodes that do not define a URL.

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. Therefore, if a node provides a URL, it must be unique within the scope of the site map provider. If no URL is provided, a unique identifier is generated to identify the SiteMapNode.

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0