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

Article
12/21/2012

Specifies the name of the provider and the class that implements it.

configuration Element (General Settings Schema)
  system.web Element (ASP.NET Settings Schema)
    webParts Element (ASP.NET Settings Schema)
      personalization Element for webParts (ASP.NET Settings Schema)
        providers Element for personalization for webParts (ASP.NET Settings Schema)
          add Element for providers for webParts (ASP.NET Settings Schema)

<add name="String" 
     type="String" 
     connectionStringName="String" 
     applicationName="String" 
     commandTimeout="number"/>

Attributes and Elements

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

Attributes

Attribute	Description
applicationName	Optional String attribute. Specifies the name of the application to store and retrieve personalization information for.
connectionStringName	Required String attribute. Specifies the SQL provider-specific string used to connect to the database.
commandTimeout	Optional Int32 attribute. Specifies the number of seconds before a command issued to the Web Parts personalization data source times out. This time-out is used by the SQL provider when creating SqlCommand objects. This attribute is not set by default in the ASP.NET configuration. As a result the ADO.NET default of 30 seconds is used. If this attribute is set, then the SQL provider uses the configured time-out value for all SQL commands issued to the database.
name	Required String attribute. The provider friendly name.
type	Required String attribute. Specifies a fully qualified assembly reference to a class that implements the PersonalizationProvider base class. Depending on where the code containing the provider is located, this can be either a partial reference (for example, only Namespace.ClassName or Namespace.Classname, AssemblyName), or it can be a fully qualified assembly reference to a class that implements the PersonalizationProvider base class.

Child Elements

None.

Parent Elements

Element	Description
configuration	The required root element in every configuration file used by the common language runtime and .NET Framework applications.
system.web	Specifies the root element for the ASP.NET configuration settings in a configuration file. Contains configuration elements that configure ASP.NET Web applications and control how the applications behave.
webParts	Allows you to specify a Web Parts personalization provider, set personalization authorizations, and add custom classes that extend the WebPartTransformer class for use by Web Parts connections.
personalization	Specifies the Web Parts personalization provider and sets Web Parts personalization authorizations.
providers	Defines the Web Parts personalization providers for the current Web application.

Remarks

It is important to be aware that personalization will fail if your Web application does not run at the default trust level of Medium or higher (you can set custom trust levels in a Web.config file using the <trust level="" /> element). The PersonalizationAdministration and SqlPersonalizationProvider classes both check for a trust level of Low when they are initialized. If you configure your application to run at a trust level of Low, and you use the default SqlPersonalizationProvider to manage the personalization data for your application, the first time that the application tries to access personalization data, it will fail, because an ASP.NET worker process running in Low trust does not have the permissions necessary to call into the various classes in the System.Data.SqlClient namespace.

Default Configuration

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

<providers>
  <add name="AspNetSqlPersonalizationProvider" 
    type="System.Web.UI.WebControls.WebParts.SqlPersonalizationProvider"
    connectionStringName="LocalSqlServer"
  />
</providers>

Example

The following example shows how to add a provider.

<webParts>
  <personalization defaultProvider="AspNetSqlPersonalizationProvider">
    <providers>
      <add name="AspNetSqlPersonalizationProvider"
      type="System.Web.UI.WebControls.WebParts.SqlPersonalizationProvider"
        connectionStringName="LocalSqlServer" 
        applicationName="/" />
    </providers>
  </personalization>
</webParts>

Providers may only be defined at the machine, site, and application level.

Element Information

Configuration Section Handler	System.Web.Configuration.WebPartsSection
Configuration Member	WebPartsPersonalization.Providers
Configurable Locations	Machine.config Root level Web.config Application level Web.config
Requirements	IIS 5.0, 5.1 and 6.0 .NET Framework 2.0 Visual Studio 2005

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

Attributes and Elements

Attributes

Child Elements

Parent Elements

Remarks

Default Configuration

Example

Element Information

See Also

Tasks

Reference

Concepts

Other Resources

Additional resources