Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

SiteMapProviderAdapter.HintNeighborhoodNodes Method

Provides a method that site map providers can override to perform an optimized retrieval of nodes found in the proximity of the specified node.

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

Parameters

node
The SiteMapNode that acts as a reference point for upLevel.
upLevel
The number of ancestor SiteMapNode generations to fetch. 0 indicates no ancestor nodes are retrieved and -1 indicates that all ancestors (and their descendant nodes to the level of node) might be retrieved and cached.
downLevel
The number of descendant SiteMapNode generations to fetch. 0 indicates no descendant nodes are retrieved and -1 indicates that all descendant nodes might be retrieved and cached.

Implements

ISiteMapProvider.HintNeighborhoodNodes

Exceptions

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

See Also

SiteMapProviderAdapter Class | Spring.Web.Providers Namespace