ProviderSettings Class

Definition

Represents the configuration elements associated with a provider.

public ref class ProviderSettings sealed : System::Configuration::ConfigurationElement
public sealed class ProviderSettings : System.Configuration.ConfigurationElement
type ProviderSettings = class
    inherit ConfigurationElement
Public NotInheritable Class ProviderSettings
Inherits ConfigurationElement
Inheritance
ProviderSettings

Examples

The following code example shows how to use the ProviderSettings.

using System;
using System.Collections;
using System.Collections.Specialized;
using System.Text;
using System.Configuration;
using System.Security.Permissions;

namespace Samples.AspNet
{

    // Shows how to use the ProviderSettings.
    public class UsingProviderSettings
    {

        [PermissionSet(SecurityAction.Demand, Name = "FullTrust")]
        private static void GetProviderSettings()
        {
            // Get the application configuration file.
            System.Configuration.Configuration config =
                    ConfigurationManager.OpenExeConfiguration(
                    ConfigurationUserLevel.None);

            ProtectedConfigurationSection pSection =
                config.GetSection("configProtectedData")
                as ProtectedConfigurationSection;

            ProviderSettingsCollection providerSettings =
              pSection.Providers;

            foreach (ProviderSettings pSettings in
                providerSettings)
            {


                Console.WriteLine(
                    "Provider settings name: {0}",
                    pSettings.Name);


                Console.WriteLine(
                    "Provider settings type: {0}",
                       pSettings.Type);

                NameValueCollection parameters =
                    pSettings.Parameters;

                IEnumerator pEnum =
                    parameters.GetEnumerator();

                int i = 0;
                while (pEnum.MoveNext())
                {
                    string pLength =
                        parameters[i].Length.ToString();
                    Console.WriteLine(
                        "Provider ssettings: {0} has {1} parameters",
                        pSettings.Name, pLength);
                }
            }
        }

        static void Main(string[] args)
        {

            GetProviderSettings();
        }
    }
}
Imports System.Collections
Imports System.Collections.Specialized
Imports System.Text
Imports System.Configuration
Imports System.Security.Permissions


' Shows how to use the ProviderSettings.
Namespace Samples.AspNet


    Public Class UsingProviderSettings


        <PermissionSet( _
           SecurityAction.Demand, Name:="FullTrust")> _
           Private Shared Sub GetProviderSettings()
            ' Get the application configuration file.
            Dim config _
            As System.Configuration.Configuration = _
            ConfigurationManager.OpenExeConfiguration( _
            ConfigurationUserLevel.None)

            Dim pSection As _
            ProtectedConfigurationSection = _
            config.GetSection("configProtectedData")

            Dim providerSettings _
            As ProviderSettingsCollection = _
            pSection.Providers

            Dim pSettings As ProviderSettings
            For Each pSettings In providerSettings

                Console.WriteLine( _
                "Provider settings name: {0}", _
                pSettings.Name)


                Console.WriteLine( _
                "Provider settings type: {0}", _
                pSettings.Type)

                Dim parameters _
                As NameValueCollection = pSettings.Parameters

                Dim pEnum _
                As IEnumerator = parameters.GetEnumerator()

                Dim i As Integer = 0
                While pEnum.MoveNext()
                    Dim pLength As String = _
                    parameters(i).Length.ToString()
                    Console.WriteLine( _
                    "Provider ssettings: {0} has {1} parameters", _
                    pSettings.Name, pLength)
                End While
            Next pSettings

        End Sub


        Public Shared Sub Main(ByVal args() As String)

            GetProviderSettings()
        End Sub
    End Class

End Namespace

The following is an excerpt of the configuration file used by the above example.

<?xml version="1.0" encoding="utf-8" ?>  
<configuration>  

  <configProtectedData>  

    <providers>  
      <clear />  
      <add  
         name="TripleDESProtectedConfigurationProvider"   
         type="Samples.Aspnet.TripleDESProtectedConfigurationProvider, protectedconfigurationproviderlib, Version=1.0.0.0, Culture=neutral,   
PublicKeyToken=79e01ae0f5cfc66f, processorArchitecture=MSIL" />  

    </providers>  

  </configProtectedData>  

</configuration>  

Remarks

ASP.NET uses providers to perform specific services required by a feature. For example, the membership feature uses a provider to coordinate the persistence of membership data in a database.

In a configuration file, individual providers are added to a providers element within a particular feature section.

The ProviderSettings class represents a particular group of settings that are added to the providers element within a configuration section. Typically the configuration attributes specified by the add directive include a name, type, and other properties.

Constructors

ProviderSettings()

Initializes a new instance of the ProviderSettings class.

ProviderSettings(String, String)

Initializes a new instance of the ProviderSettings class.

Properties

CurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Inherited from ConfigurationElement)
ElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Inherited from ConfigurationElement)
ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext

Gets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String]

Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
LockAllAttributesExcept

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockElements

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem

Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
Name

Gets or sets the name of the provider configured by this class.

Parameters

Gets a collection of user-defined parameters for the provider.

Properties

Gets the collection of properties.

(Inherited from ConfigurationElement)
Type

Gets or sets the type of the provider configured by this class.

Methods

DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
Equals(Object)

Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode()

Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init()

Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
IsModified()

Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.

(Inherited from ConfigurationElement)
IsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList)

Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement)

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Inherited from ConfigurationElement)
ResetModified()

Resets the value of the IsModified() method to false when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly()

Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Inherited from ConfigurationElement)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved.

(Inherited from ConfigurationElement)

Applies to

See also