XmlSiteMapProvider.RootNode Property

Definition

Namespace:
System.Web
Assembly:
System.Web.dll

Gets the root node of the site map.

public:
 virtual property System::Web::SiteMapNode ^ RootNode { System::Web::SiteMapNode ^ get(); };
public override System.Web.SiteMapNode RootNode { get; }
member this.RootNode : System.Web.SiteMapNode
Public Overrides ReadOnly Property RootNode As SiteMapNode

Property Value

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.

Remarks

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.

Applies to

See also