Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SiteMapProvider.HintNeighborhoodNodes Method

Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)
public virtual void HintNeighborhoodNodes(
	SiteMapNode node,
	int upLevel,
	int downLevel
)

Parameters

node
Type: System.Web.SiteMapNode
The SiteMapNode that acts as a reference point for upLevel.
upLevel
Type: System.Int32
The number of ancestor SiteMapNode generations to fetch. 0 indicates no ancestor nodes are retrieved and -1 indicates that all ancestors (and their descendant nodes to the level of node) might be retrieved and cached.
downLevel
Type: System.Int32
The number of descendant SiteMapNode generations to fetch. 0 indicates no descendant nodes are retrieved and -1 indicates that all descendant nodes might be retrieved and cached.
ExceptionCondition
ArgumentOutOfRangeException

upLevel or downLevel is less than -1.

ArgumentNullException

node is null.

The default HintNeighborhoodNodes method only checks for an upLevel and downLevel parameters that are less than -1 and a node parameter that is null. Because the XmlSiteMapProvider object caches site map information in memory, the HintNeighborhoodNodes method is not used.

Site map providers can override the HintNeighborhoodNodes method to perform an optimized lookup of the SiteMapNode objects in the proximity of the specified SiteMapNode. The upLevel parameter is used to specify how many levels of parent and ancestor nodes to traverse from the specified SiteMapNode. The downLevel parameter is used to specify how many levels of child nodes from the current node to retrieve. If preferred, the ancestor and descendant nodes can be linked to the SiteMapNode that is returned by the HintNeighborhoodNodes method, using the ParentNode and ChildNodes properties.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.