SiteMapProvider.HintAncestorNodes Method (SiteMapNode, Int32)


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.

Namespace:   System.Web
Assembly:  System.Web (in System.Web.dll)

abstract HintAncestorNodes : 
        node:SiteMapNode *
        upLevel:int -> unit
override HintAncestorNodes : 
        node:SiteMapNode *
        upLevel:int -> unit


Type: System.Web.SiteMapNode

The SiteMapNode that acts as a reference point for upLevel.

Type: System.Int32

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.

Exception Condition

upLevel is less than -1.


node is null.

The default HintAncestorNodes method only checks for an upLevel parameter that is less than -1 and a node parameter that is null. Because the XmlSiteMapProvider class caches site map information in memory, the HintAncestorNodes method is not used.

Site map providers can override the HintAncestorNodes method to perform an optimized retrieval of parent and ancestor nodes of the specified SiteMapNode object.

The upLevel parameter is used to specify how many levels of parent and ancestor nodes to traverse from the specified SiteMapNode. If fewer levels exist than are requested, all available ancestor nodes are returned within the specified bound. If preferred, the parent node can be linked to the specified SiteMapNode using the ParentNode property.

.NET Framework
Available since 2.0
Return to top