SiteMapProvider.FindSiteMapNode Method (String)

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

When overridden in a derived class, retrieves a SiteMapNode object that represents the page at the specified URL.

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

public:
virtual SiteMapNode^ FindSiteMapNode (
	String^ rawUrl
) abstract
public abstract SiteMapNode FindSiteMapNode (
	String rawUrl
)
public abstract function FindSiteMapNode (
	rawUrl : String
) : SiteMapNode

Parameters

rawUrl

A URL that identifies the page for which to retrieve a SiteMapNode.

Return Value

A SiteMapNode that represents the page identified by rawURL; 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.

Classes that derive from the SiteMapProvider class must implement the abstract FindSiteMapNode method.

The URL provided can be a virtual or absolute URL. It might also be a URL that uses application-relative syntax, such as ~/apprelativedirectory. Ensure that any implementation of the FindSiteMapNode method parse and handle application-relative syntax properly.

The XmlSiteMapProvider class, which is the default site map provider for ASP.NET, uses the URL of a SiteMapNode object as a key in the various collections that the classes maintain. Therefore, if a SiteMapNode 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.

Notes to Inheritors When overriding the FindSiteMapNode method in a derived class, be sure to extend the search to any child providers, if a SiteMapNode object that matches the URL is not found by the provider in the current site map and the provider supports child providers.

The following code example demonstrates how to implement the FindSiteMapNode method in a class that implements the abstract SiteMapProvider class. The SimpleTextSiteMapProvider uses a helper method, named FindUrl, to get the URL of the currently displayed page from the HttpContext object.

This code example is part of a larger example provided for the SiteMapProvider class.

No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.

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

Community Additions

ADD
Show: