RootNode Property

SiteMapProvider.RootNode Property

 

Gets the root SiteMapNode object of the site map data that the current provider represents.

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

public virtual SiteMapNode RootNode { get; }

Property Value

Type: System.Web.SiteMapNode

The root SiteMapNode of the current site map data provider. The default implementation performs security trimming on the returned node.

The default implementation calls the abstract GetRootNodeCore method.

Notes to Inheritors:

When overriding the RootNode property in a derived class, be sure that the implementation does not navigate the provider hierarchy, if one exists, to find the absolute root node of the site.

The following code example demonstrates how to implement the RootNode property in a class that implements the abstract SiteMapProvider class.

This code example is part of a larger example provided for the SiteMapProvider class.

// Implement the CurrentNode property.
public override SiteMapNode CurrentNode
{
  get
  {
    string currentUrl = FindCurrentUrl();
    // Find the SiteMapNode that represents the current page.
    SiteMapNode currentNode = FindSiteMapNode(currentUrl);
    return currentNode;
  }
}

// Implement the RootNode property.
public override SiteMapNode RootNode
{
  get
  {
    return rootNode;
  }
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft