Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

ISiteMapProvider.GetParentNodeRelativeToCurrentNodeAndHintDownFromParent Method

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

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

Parameters

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

Exceptions

Exception Type Condition
ArgumentOutOfRangeException walkupLevels or relativeDepthFromWalkup is less than 0.

See Also

ISiteMapProvider Interface | Spring.Web.Providers Namespace