SiteMap.RootNode Property
Assembly: System.Web (in system.web.dll)
/** @property */ public static SiteMapNode get_RootNode ()
public static function get RootNode () : SiteMapNode
Property Value
A SiteMapNode that represents the top-level page of the site's navigation structure; otherwise, a null reference (Nothing in Visual Basic), if security trimming is enabled and the node cannot be returned to the current user.| Exception type | Condition |
|---|---|
| The site map feature is not enabled. - or - The RootNode resolves to a null reference (Nothing in Visual Basic), which occurs if security trimming is enabled and the root node is not visible to the current user. | |
| The default provider specified in the configuration does not exist. | |
| The feature is supported only when running in Low trust or higher. |
The SiteMap class retrieves the RootNode property by requesting it from the provider. If there is a provider hierarchy, the SiteMap class retrieves the root node of the root provider in the hierarchy. To access the root node of the default provider, call the Provider property, which retrieves both the default provider and its RootNode property.
The XmlSiteMapProvider object, which is the default provider for the SiteMap class, supports only one RootNode.
If you implement your own SiteMapProvider class and override the abstract RootNode property, you must provide your own implementation to track the RootNode property of the SiteMapNode instance.
The root node must be visible to all users, by design. If the root node is not visible to all users when security trimming is enabled, accessing the RootNode property might result in an InvalidOperationException exception.
Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.