ProviderSettingsCollection Class (System.Configuration)

Switch View :
ScriptFree
.NET Framework Class Library
ProviderSettingsCollection Class

Represents a collection of ProviderSettings objects.

Inheritance Hierarchy

System.Object
  System.Configuration.ConfigurationElement
    System.Configuration.ConfigurationElementCollection
      System.Configuration.ProviderSettingsCollection

Namespace:  System.Configuration
Assembly:  System.Configuration (in System.Configuration.dll)
Syntax

Visual Basic
<ConfigurationCollectionAttribute(GetType(ProviderSettings))> _
Public NotInheritable Class ProviderSettingsCollection _
	Inherits ConfigurationElementCollection
C#
[ConfigurationCollectionAttribute(typeof(ProviderSettings))]
public sealed class ProviderSettingsCollection : ConfigurationElementCollection
Visual C++
[ConfigurationCollectionAttribute(typeof(ProviderSettings))]
public ref class ProviderSettingsCollection sealed : public ConfigurationElementCollection
F#
[<Sealed>]
[<ConfigurationCollectionAttribute(typeof(ProviderSettings))>]
type ProviderSettingsCollection =  
    class
        inherit ConfigurationElementCollection
    end

The ProviderSettingsCollection type exposes the following members.

Constructors

  Name Description
Public method ProviderSettingsCollection Initializes a new instance of the ProviderSettingsCollection class.
Top
Properties

  Name Description
Protected property AddElementName Gets or sets the name of the ConfigurationElement to associate with the add operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected property ClearElementName Gets or sets the name for the ConfigurationElement to associate with the clear operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public property CollectionType Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public property Count Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection.)
Public property 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.)
Public property ElementInformation Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected property ElementName Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected property ElementProperty Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Public property EmitClear Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection.)
Protected property EvaluationContext Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Public property IsSynchronized Gets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ConfigurationElementCollection.)
Protected property Item[ConfigurationProperty] Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Public property Item[Int32] Gets or sets a value at the specified index in the ProviderSettingsCollection collection.
Public property Item[String] Gets an item from the collection.
Public property LockAllAttributesExcept Gets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public property LockAllElementsExcept Gets the collection of locked elements. (Inherited from ConfigurationElement.)
Public property LockAttributes Gets the collection of locked attributes (Inherited from ConfigurationElement.)
Public property LockElements Gets the collection of locked elements. (Inherited from ConfigurationElement.)
Public property LockItem Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Protected property Properties Gets the collection of properties. (Inherited from ConfigurationElement.)
Protected property RemoveElementName Gets or sets the name of the ConfigurationElement to associate with the remove operation in the ConfigurationElementCollection when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public property SyncRoot Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected property ThrowOnDuplicate Gets a value indicating whether an attempt to add a duplicate ConfigurationElement to the ConfigurationElementCollection will cause an exception to be thrown. (Inherited from ConfigurationElementCollection.)
Top
Methods

  Name Description
Public method Add Adds a ProviderSettings object to the collection.
Protected method BaseAdd(ConfigurationElement) Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected method BaseAdd(ConfigurationElement, Boolean) Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected method BaseAdd(Int32, ConfigurationElement) Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.)
Protected method BaseClear Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.)
Protected method BaseGet(Int32) Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected method BaseGet(Object) Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.)
Protected method BaseGetAllKeys Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected method BaseGetKey Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Protected method BaseIndexOf The index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection.)
Protected method BaseIsRemoved Gets a value indicating whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected method BaseRemove Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.)
Protected method BaseRemoveAt Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.)
Public method Clear Clears the collection.
Public method CopyTo Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Protected method CreateNewElement() When overridden in a derived class, creates a new ConfigurationElement. (Inherited from ConfigurationElementCollection.)
Protected method CreateNewElement(String) Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected method DeserializeElement Reads XML from the configuration file. (Inherited from ConfigurationElement.)
Public method Equals Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetElementKey Gets the element key for a specified configuration element when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public method GetEnumerator Infrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Public method GetHashCode Gets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection.)
Protected method GetTransformedAssemblyString Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
Protected method GetTransformedTypeString Returns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Init Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected method InitializeDefault Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected method IsElementName Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected method IsElementRemovable Gets a value indicating whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.)
Protected method IsModified Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Public method IsReadOnly Gets a value indicating whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.)
Protected method ListErrors Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnDeserializeUnrecognizedAttribute Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected method OnDeserializeUnrecognizedElement Causes the configuration system to throw an exception. (Inherited from ConfigurationElementCollection.)
Protected method OnRequiredPropertyNotFound Throws an exception when a required property is not found. (Inherited from ConfigurationElement.)
Protected method PostDeserialize Called after deserialization. (Inherited from ConfigurationElement.)
Protected method PreSerialize Called before serialization. (Inherited from ConfigurationElement.)
Public method Remove Removes an element from the collection.
Protected method Reset Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected method ResetModified Resets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected method SerializeElement Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.)
Protected method SerializeToXmlElement Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected method SetPropertyValue Sets a property to the specified value. (Inherited from ConfigurationElement.)
Protected method SetReadOnly Infrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method Unmerge Infrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.)
Top
Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method ICollection.CopyTo Copies the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.)
Top
Remarks

The ProviderSettingsCollection class represents the providers element within a configuration file.

Examples

The following code example shows how to iterate through the Providers property, which returns a ProviderSettingsCollection.

Visual Basic

Imports System
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 'GetProviderSettings


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

            GetProviderSettings()
        End Sub 'Main 
    End Class 'UsingProviderSettings

End Namespace



C#

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();

        }
    }
}


Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

Other Resources