Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

ISiteMapProvider.GetParentNodeRelativeToNodeAndHintDownFromParent Method

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

[Visual Basic]
Public Sub GetParentNodeRelativeToNodeAndHintDownFromParent( _
   ByVal node As SiteMapNode, _
   ByVal walkupLevels As Integer, _
   ByVal relativeDepthFromWalkup As Integer _
)
[C#]
SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent(
   SiteMapNode node,
   int walkupLevels,
   int relativeDepthFromWalkup
);

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, null, if the current or ancestor SiteMapNode is not found or cannot be returned for the current user.

Exceptions

Exception Type Condition
ArgumentOutOfRangeException The value specified for walkupLevels or relativeDepthFromWalkup is less than 0.
ArgumentNullException node is null.

See Also

ISiteMapProvider Interface | Spring.Web.Providers Namespace