Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

SiteMapProviderAdapter.GetCurrentNodeAndHintNeighborhoodNodes Method

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

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

Parameters

upLevel
The number of ancestor SiteMapNode generations to fetch. 0 indicates no ancestor nodes are retrieved and -1 indicates that all ancestors might be retrieved and cached by the provider.
downLevel
The number of child SiteMapNode generations to fetch. 0 indicates no descendant nodes are retrieved and a -1 indicates that all descendant nodes 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.GetCurrentNodeAndHintNeighborhoodNodes

Exceptions

Exception Type Condition
ArgumentOutOfRangeException upLevel or downLevel is less than -1.

See Also

SiteMapProviderAdapter Class | Spring.Web.Providers Namespace