providers Element for siteMap (ASP.NET Settings Schema)

  • Article

Defines a collection of navigation providers.

This element is new in the .NET Framework version 2.0.

<configuration> Element
  system.web Element (ASP.NET Settings Schema)
    siteMap Element (ASP.NET Settings Schema)
      providers Element for siteMap (ASP.NET Settings Schema)

<providers> 
  <add.../> 
  <remove.../> 
  <clear/> 
</providers>

Attributes and Elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child Elements

Element

Description

add

Optional element.

Adds a provider to a collection of navigation providers.

clear

Optional element.

Clears all previously defined providers.

remove

Optional element.

Removes a provider from the collection of navigation providers.

Parent Elements

Element

Description

configuration

Specifies the required root element in every configuration file that is used by the common language runtime and the .NET Framework applications.

system.web

Specifies the root element for the ASP.NET configuration section.

siteMap

Defines configuration settings to support the navigation infrastructure for configuring, storing, and rendering site navigation.

Remarks

Default Configuration

The following default providers element is configured in the root Web.config file in the .NET Framework version 2.0.

<providers>
    <add siteMapFile="web.sitemap" name="AspNetXmlSiteMapProvider"
         type="System.Web.XmlSiteMapProvider, System.Web, Version=2.0.0.0, Culture=neutral, 
         PublicKeyToken=b03f5f7f11d50a3a" />
</providers>

Example

The following code example shows how to add a site map provider in the Web.config file to override the default site map provider that is defined for ASP.NET.

<configuration>
  <system.web>
    <siteMap defaultProvider="XmlSiteMapReader">
      <providers>
        <add 
          name=" XmlSiteMapReader"
          type="XmlSiteMapProvider, System.Web, Version=1.1.3300.0,
                Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"
          siteMapFile="my.sitemap"
          description="XmlSiteMapProvider that loads my.sitemap"/>
      </providers>
    </siteMap>
  </system.web>
</configuration>

Element Information

Configuration section Handler

System.Web.Configuration.SiteMapSection

Configuration member

SiteMapSection.Providers

Configurable locations

Machine.config

Root-level Web.config

Application-level Web.config

Requirements

Microsoft Internet Information Services (IIS) version 5.0, 5.1, or 6.0

The .NET Framework version 2.0

Microsoft Visual Studio 2005

See Also

Tasks

How to: Lock ASP.NET Configuration Settings

Reference

siteMap Element (ASP.NET Settings Schema)

system.web Element (ASP.NET Settings Schema)

<configuration> Element

add Element for providers for siteMap (ASP.NET Settings Schema)

clear Element for providers for siteMap (ASP.NET Settings Schema)

remove Element for providers for siteMap (ASP.NET Settings Schema)

System.Configuration

System.Web.Configuration

Concepts

ASP.NET Configuration Overview

ASP.NET Web Server Controls and Browser Capabilities

Securing ASP.NET Configuration

ASP.NET Configuration Scenarios

Other Resources

ASP.NET Configuration Files

ASP.NET Configuration Settings

General Configuration Settings (ASP.NET)

ASP.NET Configuration API