Export (0) Print
Expand All

SiteMapProvider.HintAncestorNodes Method

Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified SiteMapNode object.

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

public virtual void HintAncestorNodes (
	SiteMapNode node,
	int upLevel
)
public void HintAncestorNodes (
	SiteMapNode node, 
	int upLevel
)
public function HintAncestorNodes (
	node : SiteMapNode, 
	upLevel : int
)
Not applicable.

Parameters

node

The SiteMapNode that acts as a reference point for upLevel.

upLevel

The number of ancestor SiteMapNode generations to fetch. 0 indicates no ancestor nodes are retrieved and -1 indicates that all ancestors might be retrieved and cached.

Exception typeCondition

ArgumentOutOfRangeException

upLevel is less than -1.

ArgumentNullException

node is a null reference (Nothing in Visual Basic).

The default HintAncestorNodes method only checks for an upLevel parameter that is less than -1 and a node parameter that is a null reference (Nothing in Visual Basic). Because the XmlSiteMapProvider class caches site map information in memory, the HintAncestorNodes method is not used.

Site map providers can override the HintAncestorNodes method to perform an optimized retrieval of parent and ancestor nodes of the specified SiteMapNode object.

The upLevel parameter is used to specify how many levels of parent and ancestor nodes to traverse from the specified SiteMapNode. If fewer levels exist than are requested, all available ancestor nodes are returned within the specified bound. If preferred, the parent node can be linked to the specified SiteMapNode using the ParentNode property.

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2015 Microsoft