SiteMapProvider::RootProvider Property
Gets the root SiteMapProvider object in the current provider hierarchy.
Assembly: System.Web (in System.Web.dll)
Property Value
Type: System.Web::SiteMapProvider^An SiteMapProvider that is the top-level site map provider in the provider hierarchy that the current provider belongs to.
| Exception | Condition |
|---|---|
| ProviderException | There is a circular reference to the current site map provider. |
All classes that implement the SiteMapProvider class can support the concept of a site map provider hierarchy. Any hierarchical relationships between providers are maintained outside the scope of a SiteMapProviderCollection collection by the providers themselves. For an example of a functional provider hierarchy, see XmlSiteMapProvider.
The following code example demonstrates how to implement the RootProvider property in a class that implements the abstract SiteMapProvider class. The SimpleTextSiteMapProvider uses simple logic to determine whether the current provider is part of a provider hierarchy. If the provider is part of a hierarchy, it uses the RootProvider property for the parent provider as its own. If the provider is not part of a hierarchy, the provider is its own root provider.
This code example is part of a larger example provided for the SiteMapProvider class.
Available since 2.0