SiteMapProvider.GetParentNodeRelativeToNodeAndHintDownFromParent Method (SiteMapNode, Int32, Int32)
Provides an optimized lookup method for site map providers when retrieving an ancestor node for the specified SiteMapNode object and fetching its child nodes.
Assembly: System.Web (in System.Web.dll)
public virtual SiteMapNode GetParentNodeRelativeToNodeAndHintDownFromParent( SiteMapNode node, int walkupLevels, int relativeDepthFromWalkup )
The SiteMapNode that acts as a reference point for walkupLevels and relativeDepthFromWalkup.
The number of ancestor node levels to traverse when retrieving the requested ancestor node.
The number of descendant node levels to retrieve from the target ancestor node.
The default implementation of the SiteMapProvider class provides a non-optimized implementation of the method, calling the HintAncestorNodes and HintNeighborhoodNodes methods; however, site map providers can override the method and provide an optimized implementation that uses custom caching mechanisms to return the ancestor node and perform an optimized lookup of the other SiteMapNode objects. The method is very similar to the GetParentNodeRelativeToCurrentNodeAndHintDownFromParent method.
The walkupLevels parameter is used to specify how many levels of parent and ancestor nodes to traverse when retrieving the target node. If fewer levels exist than are requested, null is returned. The downLevel parameter is used to specify how many levels of descendant nodes from the target ancestor node to retrieve. If preferred, the ancestor and descendant nodes can be linked to the SiteMapNode that is returned by the method, using the ParentNode and ChildNodes properties. If there are fewer ancestor node levels than specified by the upLevel parameter, null is returned. It is up to the provider implementer to decide how to handle the situation where the number of available descendant node levels is less than the value that is specified by the downLevel parameter.
Available since 2.0