SiteMap.Enabled Property

Reference

Definition

Namespace:: System.Web

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a Boolean value indicating if a site map provider is specified in the Web.config file and if the site map provider is enabled.

public:
 static property bool Enabled { bool get(); };

public static bool Enabled { get; }

static member Enabled : bool

Public Shared ReadOnly Property Enabled As Boolean

Property Value

Boolean

true if a site map provider is configured and enabled; otherwise, false.

Examples

The following code example is a Web.config configuration section that demonstrates how an XmlSiteMapProvider object is declared to be the default SiteMapProvider object.

<siteMap defaultProvider="MyXmlSiteMapProvider" enabled="true">  
  <providers>  
    <add name="MyXmlSiteMapProvider"  
      description="SiteMap provider that reads in .sitemap XML files."  
      type="System.Web.XmlSiteMapProvider, System.Web, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"  
      siteMapFile="my.sitemap" />  
  </providers>  
</siteMap>

Remarks

A default site map configuration is specified that manages the site navigation configuration. You can override this configuration in the Web.config file, should you choose to write your own site map provider.

Applies to