add Element for providers for siteMap (ASP.NET Settings Schema)
Adds a provider to the collection of navigation providers.
This element is new in the .NET Framework version 2.0.
<add
name="provider name"
type="provider type"
description="description"
siteMapFile="path"
/>
Attributes and Elements
The following sections describe the attributes, child elements, and parent elements.
Attributes
Attribute | Description |
---|---|
description |
Required String attribute. Describes the site map provider. |
name |
Required String attribute. Specifies the name of the provider to add. |
siteMapFile |
Optional String attribute. Specifies the file that contains the site map data. The siteMapFile reference can be any one of the following:
|
type |
Required String attribute. Specifies a type that implements the ProviderBase class. The type value must be a fully qualified assembly reference. |
securityTrimmingEnabled |
Defaults to false. If true, and if the provider includes the necessary logic, the site map provider performs a role check against retrieved nodes. The provider also performs a role check against the current user. The URL authorization rules for the application are applied and if Microsoft Windows authentication is being used, the file authorization rules for the application also apply. |
Child Elements
None.
Parent Elements
Element | Description |
---|---|
configuration |
Provides the 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. |
providers |
Defines a collection of navigation providers. |
Remarks
Default Configuration
The following default add element is configured in the root Web.config file in the .NET Framework version 2.0.
<add siteMapFile="web.sitemap" name="AspNetXmlSiteMapProvider"
type="System.Web.XmlSiteMapProvider, System.Web, Version=2.0.0.0, Culture=neutral,
PublicKeyToken=b03f5f7f11d50a3a" />
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>
<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 |
|
Configuration member |
|
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
providers Element for siteMap (ASP.NET Settings Schema)
siteMap Element (ASP.NET Settings Schema)
system.web Element (ASP.NET Settings Schema)
<configuration> Element
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