GetCurrentNodeAndHintAncestorNodes Method

SiteMapProvider.GetCurrentNodeAndHintAncestorNodes Method (Int32)


Provides an optimized lookup method for site map providers when retrieving the node for the currently requested page and fetching the parent and ancestor site map nodes for the current page.

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

public virtual SiteMapNode GetCurrentNodeAndHintAncestorNodes(
	int upLevel


Type: System.Int32

The number of ancestor site map node generations to get. A value of -1 indicates that all ancestors might be retrieved and cached by the provider.

Return Value

Type: System.Web.SiteMapNode

A SiteMapNode that represents the currently requested page; otherwise, null, if the SiteMapNode is not found or cannot be returned for the current user.

Exception Condition

upLevel is less than -1.

The default implementation of the GetCurrentNodeAndHintAncestorNodes method returns the CurrentNode property; however, site map providers can override the GetCurrentNodeAndHintAncestorNodes method and provide an optimized implementation that uses custom caching mechanisms to return the current SiteMapNode, as well as the parent and ancestor nodes of the parent.

The upLevel parameter is used to specify how many levels of parent and ancestor nodes to retrieve. If preferred, the parent and ancestor nodes can be linked to the SiteMapNode object that is returned by the GetCurrentNodeAndHintAncestorNodes method, using the ParentNode property.

The XmlSiteMapProvider class, which is the default site map provider for ASP.NET, caches the entire site map in memory, which results in little or no overhead when querying the XmlSiteMapProvider for specific SiteMapNode objects.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft