This documentation is archived and is not being maintained.

SiteMapProvider.GetParentNodeRelativeToNodeAndHintDownFromParent Method

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

Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified SiteMapNode object and fetching its child nodes.

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

public virtual SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent (
	SiteMapNode node,
	int walkupLevels,
	int relativeDepthFromWalkup
)
public SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent (
	SiteMapNode node, 
	int walkupLevels, 
	int relativeDepthFromWalkup
)
public function GetParentNodeRelativeToNodeAndHintDownFromParent (
	node : SiteMapNode, 
	walkupLevels : int, 
	relativeDepthFromWalkup : int
) : SiteMapNode

Parameters

node

The SiteMapNode that acts as a reference point for walkupLevels and relativeDepthFromWalkup.

walkupLevels

The number of ancestor node levels to traverse when retrieving the requested ancestor node.

relativeDepthFromWalkup

The number of descendant node levels to retrieve from the target ancestor node.

Return Value

A SiteMapNode that represents an ancestor of node; otherwise, a null reference (Nothing in Visual Basic), if the current or ancestor SiteMapNode is not found or cannot be returned for the current user.

Exception typeCondition

ArgumentOutOfRangeException

The value specified for walkupLevels or relativeDepthFromWalkup is less than 0.

ArgumentNullException

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

The default implementation of the SiteMapProvider class provides a non-optimized implementation of the GetParentNodeRelativeToNodeAndHintDownFromParent method, calling the HintAncestorNodes and HintNeighborhoodNodes methods; however, site map providers can override the GetParentNodeRelativeToNodeAndHintDownFromParent method and provide an optimized implementation that uses custom caching mechanisms to return the ancestor node and perform an optimized lookup of the other SiteMapNode objects. The GetParentNodeRelativeToNodeAndHintDownFromParent method is very similar to the GetParentNodeRelativeToCurrentNodeAndHintDownFromParent method.

The walkupLevels parameter is used to specify how many levels of parent and ancestor nodes to traverse when retrieving the target node. If fewer levels exist than are requested, a null reference (Nothing in Visual Basic) is returned. The downLevel parameter is used to specify how many levels of descendant nodes from the target ancestor node to retrieve. If preferred, the ancestor and descendant nodes can be linked to the SiteMapNode that is returned by the GetParentNodeRelativeToNodeAndHintDownFromParent method, using the ParentNode and ChildNodes properties. If there are fewer ancestor node levels than specified by the upLevel parameter, a null reference (Nothing in Visual Basic) is returned. It is up to the provider implementer to decide how to handle the situation where the number of available descendant node levels is less than the value that is specified by the downLevel parameter.

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
Show: