XmlSiteMapProvider::RootNode Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the root node of the site map.

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

public:
property SiteMapNode^ RootNode {
	virtual SiteMapNode^ get() override;
}

Property Value

Type: System.Web::SiteMapNode^

A SiteMapNode that represents the root node of the site map; otherwise, null, if security trimming is enabled and the root node is not accessible to the current user.

The RootNode property calls the BuildSiteMap method to retrieve the top-level node in the site map. Therefore, any exceptions that occur for the BuildSiteMap method can also occur when accessing the RootNode property.

The SiteMapProvider and XmlSiteMapProvider classes permit only one root SiteMapNode object in a site map. The XmlSiteMapProvider class overrides the abstract SiteMapProvider::RootNode property and provides a simple implementation to track the root node.

.NET Framework
Available since 2.0
Return to top
Show: