.NET Framework Class Library
KeyValueConfigurationCollection Class
Contains a collection of KeyValueConfigurationElement objects.
Inheritance Hierarchy
System.Object
System.Configuration.ConfigurationElement
System.Configuration.ConfigurationElementCollection
System.Configuration.KeyValueConfigurationCollection
Namespace: System.Configuration
Assembly: System.Configuration (in System.Configuration.dll)
Syntax
Visual Basic
<ConfigurationCollectionAttribute(GetType(KeyValueConfigurationElement))> _ Public Class KeyValueConfigurationCollection _ Inherits ConfigurationElementCollection
C#
[ConfigurationCollectionAttribute(typeof(KeyValueConfigurationElement))] public class KeyValueConfigurationCollection : ConfigurationElementCollection
Visual C++
[ConfigurationCollectionAttribute(typeof(KeyValueConfigurationElement))] public ref class KeyValueConfigurationCollection : public ConfigurationElementCollection
F#
[<ConfigurationCollectionAttribute(typeof(KeyValueConfigurationElement))>] type KeyValueConfigurationCollection = class inherit ConfigurationElementCollection end
The KeyValueConfigurationCollection type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
KeyValueConfigurationCollection | Initializes a new instance of the KeyValueConfigurationCollection class. |
Properties
| Name | Description | |
|---|---|---|
|
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.) |
|
AllKeys | Gets the keys to all items contained in the KeyValueConfigurationCollection collection. |
|
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.) |
|
CollectionType | Gets the type of the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
Count | Gets the number of elements in the collection. (Inherited from ConfigurationElementCollection.) |
|
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.) |
|
ElementName | Gets the name used to identify this collection of elements in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
|
ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.) |
|
EmitClear | Gets or sets a value that specifies whether the collection has been cleared. (Inherited from ConfigurationElementCollection.) |
|
EvaluationContext | Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.) |
|
IsSynchronized | Gets a value indicating whether access to the collection is synchronized (thread safe). (Inherited from ConfigurationElementCollection.) |
|
Item[ConfigurationProperty] | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.) |
|
Item[String] | Gets the KeyValueConfigurationElement object based on the supplied parameter. |
|
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.) |
|
Properties | Gets a collection of configuration properties. (Overrides ConfigurationElement.Properties.) |
|
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.) |
|
SyncRoot | Gets an object used to synchronize access to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
ThrowOnDuplicate | Gets a value indicating whether an attempt to add a duplicate KeyValueConfigurationElement object to the KeyValueConfigurationCollection collection will cause an exception to be thrown. (Overrides ConfigurationElementCollection.ThrowOnDuplicate.) |
Methods
| Name | Description | |
|---|---|---|
|
Add(KeyValueConfigurationElement) | Adds a KeyValueConfigurationElement object to the collection based on the supplied parameters. |
|
Add(String, String) | Adds a KeyValueConfigurationElement object to the collection based on the supplied parameters. |
|
BaseAdd(ConfigurationElement) | Adds a configuration element to the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
BaseAdd(ConfigurationElement, Boolean) | Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.) |
|
BaseAdd(Int32, ConfigurationElement) | Adds a configuration element to the configuration element collection. (Inherited from ConfigurationElementCollection.) |
|
BaseClear | Removes all configuration element objects from the collection. (Inherited from ConfigurationElementCollection.) |
|
BaseGet(Int32) | Gets the configuration element at the specified index location. (Inherited from ConfigurationElementCollection.) |
|
BaseGet(Object) | Returns the configuration element with the specified key. (Inherited from ConfigurationElementCollection.) |
|
BaseGetAllKeys | Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
BaseGetKey | Gets the key for the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.) |
|
BaseIndexOf | The index of the specified ConfigurationElement. (Inherited from ConfigurationElementCollection.) |
|
BaseIsRemoved | Gets a value indicating whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
BaseRemove | Removes a ConfigurationElement from the collection. (Inherited from ConfigurationElementCollection.) |
|
BaseRemoveAt | Removes the ConfigurationElement at the specified index location. (Inherited from ConfigurationElementCollection.) |
|
Clear | Clears the KeyValueConfigurationCollection collection. |
|
CopyTo | Copies the contents of the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.) |
|
CreateNewElement() | When overridden in a derived class, the CreateNewElement method creates a new KeyValueConfigurationElement object. (Overrides ConfigurationElementCollection.CreateNewElement().) |
|
CreateNewElement(String) | Creates a new ConfigurationElement when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
|
DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement.) |
|
Equals | Compares the ConfigurationElementCollection to the specified object. (Inherited from ConfigurationElementCollection.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetElementKey | Gets the element key for a specified configuration element when overridden in a derived class. (Overrides ConfigurationElementCollection.GetElementKey(ConfigurationElement).) |
|
GetEnumerator | Infrastructure. Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
GetHashCode | Gets a unique value representing the ConfigurationElementCollection instance. (Inherited from ConfigurationElementCollection.) |
|
GetTransformedAssemblyString | Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.) |
|
GetTransformedTypeString | 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.) |
|
IsElementName | Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
IsElementRemovable | Gets a value indicating whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection. (Inherited from ConfigurationElementCollection.) |
|
IsModified | Indicates whether this ConfigurationElementCollection has been modified since it was last saved or loaded when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
|
IsReadOnly | Gets a value indicating whether the ConfigurationElementCollection object is read only. (Inherited from ConfigurationElementCollection.) |
|
ListErrors | 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 | Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.) |
|
OnDeserializeUnrecognizedElement | Causes the configuration system to throw an exception. (Inherited from ConfigurationElementCollection.) |
|
OnRequiredPropertyNotFound | Throws an exception when a required property is not found. (Inherited from ConfigurationElement.) |
|
PostDeserialize | Called after deserialization. (Inherited from ConfigurationElement.) |
|
PreSerialize | Called before serialization. (Inherited from ConfigurationElement.) |
|
Remove | Removes a KeyValueConfigurationElement object from the collection. |
|
Reset | Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
|
ResetModified | Resets the value of the IsModified property to false when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
|
SerializeElement | Writes the configuration data to an XML element in the configuration file when overridden in a derived class. (Inherited from ConfigurationElementCollection.) |
|
SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.) |
|
SetPropertyValue | Sets a property to the specified value. (Inherited from ConfigurationElement.) |
|
SetReadOnly | Infrastructure. Sets the IsReadOnly property for the ConfigurationElementCollection object and for all sub-elements. (Inherited from ConfigurationElementCollection.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
Unmerge | Infrastructure. Reverses the effect of merging configuration information from different levels of the configuration hierarchy (Inherited from ConfigurationElementCollection.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
|
ICollection.CopyTo | Copies the ConfigurationElementCollection to an array. (Inherited from ConfigurationElementCollection.) |
Remarks
This class represents a collection of pairs, where each pair consists of a string serving as a collection key and a string value. Because the first element is a key, it must be unique across the collection.
Examples
The following code example demonstrates how to use the KeyValueConfigurationCollection type.
Visual Basic
Imports System Imports System.Collections.Generic Imports System.Text Imports System.Configuration Imports System.Web Imports System.Web.Configuration Namespace Samples.Aspnet.Config Class KeyValueConfigCollection Public Shared Sub Main() Try ' Set the path of the config file. Dim configPath As String = "/aspnet" ' Get the Web application configuration object. Dim config As Configuration = _ WebConfigurationManager.OpenWebConfiguration(configPath) ' Get the section related object. Dim configSection As System.Configuration.AppSettingsSection = _ CType(config.GetSection("appSettings"), System.Configuration.AppSettingsSection) ' Dim configSection As AppSettingsSection = _ ' (AppSettingsSection)config.GetSection("appSettings") ' Display title and info. Console.WriteLine("ASP.NET Configuration Info") Console.WriteLine() ' Display Config details. Console.WriteLine("File Path: {0}", config.FilePath) Console.WriteLine("Section Path: {0}", _ configSection.SectionInformation.Name.ToString()) Console.WriteLine() ' Create the KeyValueConfigurationElement. Dim myAdminKeyVal As KeyValueConfigurationElement = _ New KeyValueConfigurationElement _ ("myAdminTool", "admin.aspx") ' Determine if the configuration contains ' any KeyValueConfigurationElements. Dim configSettings As KeyValueConfigurationCollection = _ config.AppSettings.Settings() If configSettings.AllKeys.Length = 0 Then ' Add KeyValueConfigurationElement to collection. config.AppSettings.Settings.Add(myAdminKeyVal) If Not configSection.SectionInformation.IsLocked Then config.Save() Console.WriteLine("** Configuration updated.") Else Console.WriteLine("** Could not update, section is locked.") End If End If ' Get the KeyValueConfigurationCollection ' from the configuration. Dim settings As KeyValueConfigurationCollection = _ config.AppSettings.Settings() ' Display each KeyValueConfigurationElement. Dim keyValueElement As KeyValueConfigurationElement For Each keyValueElement In settings Console.WriteLine("Key: {0}", keyValueElement.Key) Console.WriteLine("Value: {0}", keyValueElement.Value) Console.WriteLine() Next Catch e As System.ArgumentException ' Unknown error. Console.WriteLine(e.ToString()) End Try ' Display and wait Console.ReadLine() End Sub End Class End Namespace
C#
using System; using System.Collections.Generic; using System.Text; using System.Configuration; using System.Web; using System.Web.Configuration; namespace Samples.Aspnet.Config { class KeyValueConfigCollection { static void Main(string[] args) { try { // Set the path of the config file. string configPath = "/aspnet"; // Get the Web application configuration object. Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath); // Get the section related object. AppSettingsSection configSection = (AppSettingsSection)config.GetSection ("appSettings"); // Display title and info. Console.WriteLine("ASP.NET Configuration Info"); Console.WriteLine(); // Display Config details. Console.WriteLine("File Path: {0}", config.FilePath); Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name.ToString()); Console.WriteLine(); // Create the KeyValueConfigurationElement. KeyValueConfigurationElement myAdminKeyVal = new KeyValueConfigurationElement( "myAdminTool", "admin.aspx"); // Determine if the configuration contains // any KeyValueConfigurationElements. KeyValueConfigurationCollection configSettings = config.AppSettings.Settings; if (configSettings.AllKeys.Length == 0) { // Add KeyValueConfigurationElement to collection. config.AppSettings.Settings.Add(myAdminKeyVal); if (!configSection.SectionInformation.IsLocked) { config.Save(); Console.WriteLine("** Configuration updated."); } else { Console.WriteLine("** Could not update, section is locked."); } } // Get the KeyValueConfigurationCollection // from the configuration. KeyValueConfigurationCollection settings = config.AppSettings.Settings; // Display each KeyValueConfigurationElement. foreach (KeyValueConfigurationElement keyValueElement in settings) { Console.WriteLine("Key: {0}", keyValueElement.Key); Console.WriteLine("Value: {0}", keyValueElement.Value); Console.WriteLine(); } } catch (Exception e) { // Unknown error. Console.WriteLine(e.ToString()); } // Display and wait Console.ReadLine(); } } }
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Platforms
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