Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

SiteMapProviderAdapter.GetCurrentNodeAndHintAncestorNodes Method

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

[Visual Basic]
Public Overrides Sub GetCurrentNodeAndHintAncestorNodes( _
   ByVal upLevel As Integer _
) _
    Implements ISiteMapProvider.GetCurrentNodeAndHintAncestorNodes
[C#]
public override SiteMapNode GetCurrentNodeAndHintAncestorNodes(
   int upLevel
);

Parameters

upLevel
The number of ancestor site map node generations to get. A value of -1 indicates that all ancestors might be retrieved and cached by the provider.

Return Value

A SiteMapNode that represents the currently requested page; otherwise, null, if the SiteMapNode is not found or cannot be returned for the current user.

Implements

ISiteMapProvider.GetCurrentNodeAndHintAncestorNodes

Exceptions

Exception Type Condition
ArgumentOutOfRangeException upLevel is less than -1.

See Also

SiteMapProviderAdapter Class | Spring.Web.Providers Namespace