Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

SiteMapProviderAdapter.HintAncestorNodes Method

Provides a method that site map providers can override to perform an optimized retrieval of one or more levels of parent and ancestor nodes, relative to the specified SiteMapNode object.

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

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 might be retrieved and cached.

Implements

ISiteMapProvider.HintAncestorNodes

Exceptions

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

See Also

SiteMapProviderAdapter Class | Spring.Web.Providers Namespace