KeyValueConfigurationCollection KeyValueConfigurationCollection KeyValueConfigurationCollection KeyValueConfigurationCollection Class

Definition

Contains a collection of KeyValueConfigurationElement objects.

public ref class KeyValueConfigurationCollection : System::Configuration::ConfigurationElementCollection
[System.Configuration.ConfigurationCollection(typeof(System.Configuration.KeyValueConfigurationElement), CollectionType=System.Configuration.ConfigurationElementCollectionType.AddRemoveClearMap)]
[System.Configuration.ConfigurationCollection(typeof(System.Configuration.KeyValueConfigurationElement))]
public class KeyValueConfigurationCollection : System.Configuration.ConfigurationElementCollection
type KeyValueConfigurationCollection = class
    inherit ConfigurationElementCollection
Public Class KeyValueConfigurationCollection
Inherits ConfigurationElementCollection
Inheritance
Attributes

Examples

The following code example demonstrates how to use the KeyValueConfigurationCollection type.

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

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.

Constructors

KeyValueConfigurationCollection() KeyValueConfigurationCollection() KeyValueConfigurationCollection() KeyValueConfigurationCollection()

Initializes a new instance of the KeyValueConfigurationCollection class.

Properties

AddElementName AddElementName AddElementName 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 AllKeys AllKeys AllKeys

Gets the keys to all items contained in the KeyValueConfigurationCollection collection.

ClearElementName ClearElementName ClearElementName 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 CollectionType CollectionType CollectionType

Gets the type of the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
Count Count Count Count

Gets the number of elements in the collection.

(Inherited from ConfigurationElementCollection)
CurrentConfiguration CurrentConfiguration CurrentConfiguration 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 ElementInformation ElementInformation ElementInformation

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

(Inherited from ConfigurationElement)
ElementName ElementName ElementName 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 ElementProperty ElementProperty ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EmitClear EmitClear EmitClear EmitClear

Gets or sets a value that specifies whether the collection has been cleared.

(Inherited from ConfigurationElementCollection)
EvaluationContext EvaluationContext EvaluationContext EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
HasContext HasContext HasContext HasContext

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

(Inherited from ConfigurationElement)
IsSynchronized IsSynchronized IsSynchronized IsSynchronized

Gets a value indicating whether access to the collection is synchronized.

(Inherited from ConfigurationElementCollection)
Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty] Item[ConfigurationProperty]

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

(Inherited from ConfigurationElement)
Item[String] Item[String] Item[String] Item[String]

Gets the KeyValueConfigurationElement object based on the supplied parameter.

LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept LockAllAttributesExcept

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept LockAllElementsExcept

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes LockAttributes LockAttributes LockAttributes

Gets the collection of locked attributes

(Inherited from ConfigurationElement)
LockElements LockElements LockElements LockElements

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem LockItem LockItem LockItem

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

(Inherited from ConfigurationElement)
Properties Properties Properties Properties

Gets a collection of configuration properties.

RemoveElementName RemoveElementName RemoveElementName 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 SyncRoot SyncRoot SyncRoot

Gets an object used to synchronize access to the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
ThrowOnDuplicate ThrowOnDuplicate ThrowOnDuplicate 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.

Methods

Add(KeyValueConfigurationElement) Add(KeyValueConfigurationElement) Add(KeyValueConfigurationElement) Add(KeyValueConfigurationElement)

Adds a KeyValueConfigurationElement object to the collection based on the supplied parameters.

Add(String, String) Add(String, String) Add(String, String) Add(String, String)

Adds a KeyValueConfigurationElement object to the collection based on the supplied parameters.

BaseAdd(ConfigurationElement) BaseAdd(ConfigurationElement) BaseAdd(ConfigurationElement) BaseAdd(ConfigurationElement)

Adds a configuration element to the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean) BaseAdd(ConfigurationElement, Boolean) BaseAdd(ConfigurationElement, Boolean) BaseAdd(ConfigurationElement, Boolean)

Adds a configuration element to the configuration element collection.

(Inherited from ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement) BaseAdd(Int32, ConfigurationElement) BaseAdd(Int32, ConfigurationElement) BaseAdd(Int32, ConfigurationElement)

Adds a configuration element to the configuration element collection.

(Inherited from ConfigurationElementCollection)
BaseClear() BaseClear() BaseClear() BaseClear()

Removes all configuration element objects from the collection.

(Inherited from ConfigurationElementCollection)
BaseGet(Int32) BaseGet(Int32) BaseGet(Int32) BaseGet(Int32)

Gets the configuration element at the specified index location.

(Inherited from ConfigurationElementCollection)
BaseGet(Object) BaseGet(Object) BaseGet(Object) BaseGet(Object)

Returns the configuration element with the specified key.

(Inherited from ConfigurationElementCollection)
BaseGetAllKeys() BaseGetAllKeys() BaseGetAllKeys() BaseGetAllKeys()

Returns an array of the keys for all of the configuration elements contained in the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
BaseGetKey(Int32) BaseGetKey(Int32) BaseGetKey(Int32) BaseGetKey(Int32)

Gets the key for the ConfigurationElement at the specified index location.

(Inherited from ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement) BaseIndexOf(ConfigurationElement) BaseIndexOf(ConfigurationElement) BaseIndexOf(ConfigurationElement)

Indicates the index of the specified ConfigurationElement.

(Inherited from ConfigurationElementCollection)
BaseIsRemoved(Object) BaseIsRemoved(Object) BaseIsRemoved(Object) BaseIsRemoved(Object)

Indicates whether the ConfigurationElement with the specified key has been removed from the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
BaseRemove(Object) BaseRemove(Object) BaseRemove(Object) BaseRemove(Object)

Removes a ConfigurationElement from the collection.

(Inherited from ConfigurationElementCollection)
BaseRemoveAt(Int32) BaseRemoveAt(Int32) BaseRemoveAt(Int32) BaseRemoveAt(Int32)

Removes the ConfigurationElement at the specified index location.

(Inherited from ConfigurationElementCollection)
Clear() Clear() Clear() Clear()

Clears the KeyValueConfigurationCollection collection.

CopyTo(ConfigurationElement[], Int32) CopyTo(ConfigurationElement[], Int32) CopyTo(ConfigurationElement[], Int32) CopyTo(ConfigurationElement[], Int32)

Copies the contents of the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)
CreateNewElement() CreateNewElement() CreateNewElement() CreateNewElement()

When overridden in a derived class, the CreateNewElement() method creates a new KeyValueConfigurationElement object.

CreateNewElement(String) CreateNewElement(String) CreateNewElement(String) CreateNewElement(String)

Creates a new ConfigurationElement when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean) DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Compares the ConfigurationElementCollection to the specified object.

(Inherited from ConfigurationElementCollection)
GetElementKey(ConfigurationElement) GetElementKey(ConfigurationElement) GetElementKey(ConfigurationElement) GetElementKey(ConfigurationElement)

Gets the element key for a specified configuration element when overridden in a derived class.

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Gets an IEnumerator which is used to iterate through the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gets a unique value representing the ConfigurationElementCollection instance.

(Inherited from ConfigurationElementCollection)
GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String) GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String) GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init() Init() Init() Init()

Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault() InitializeDefault() InitializeDefault() InitializeDefault()

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

(Inherited from ConfigurationElement)
IsElementName(String) IsElementName(String) IsElementName(String) IsElementName(String)

Indicates whether the specified ConfigurationElement exists in the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement) IsElementRemovable(ConfigurationElement) IsElementRemovable(ConfigurationElement) IsElementRemovable(ConfigurationElement)

Indicates whether the specified ConfigurationElement can be removed from the ConfigurationElementCollection.

(Inherited from ConfigurationElementCollection)
IsModified() IsModified() IsModified() 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() IsReadOnly() IsReadOnly() IsReadOnly()

Indicates whether the ConfigurationElementCollection object is read only.

(Inherited from ConfigurationElementCollection)
ListErrors(IList) ListErrors(IList) ListErrors(IList) ListErrors(IList)

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

(Inherited from ConfigurationElement)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String) OnDeserializeUnrecognizedAttribute(String, String)

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

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader) OnDeserializeUnrecognizedElement(String, XmlReader)

Causes the configuration system to throw an exception.

(Inherited from ConfigurationElementCollection)
OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String) OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize() PostDeserialize() PostDeserialize() PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter) PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Remove(String) Remove(String) Remove(String) Remove(String)

Removes a KeyValueConfigurationElement object from the collection.

Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement) Reset(ConfigurationElement)

Resets the ConfigurationElementCollection to its unmodified state when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
ResetModified() ResetModified() ResetModified() ResetModified()

Resets the value of the IsModified() property to false when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean) SerializeElement(XmlWriter, Boolean)

Writes the configuration data to an XML element in the configuration file when overridden in a derived class.

(Inherited from ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) SerializeToXmlElement(XmlWriter, String) 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) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean) SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetReadOnly() SetReadOnly() SetReadOnly() SetReadOnly()

Sets the IsReadOnly() property for the ConfigurationElementCollection object and for all sub-elements.

(Inherited from ConfigurationElementCollection)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

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

Reverses the effect of merging configuration information from different levels of the configuration hierarchy

(Inherited from ConfigurationElementCollection)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

Copies the ConfigurationElementCollection to an array.

(Inherited from ConfigurationElementCollection)

Extension Methods

Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable) Cast<TResult>(IEnumerable)

Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable) OfType<TResult>(IEnumerable)

Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable) AsParallel(IEnumerable)

Enables parallelization of a query.

AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable) AsQueryable(IEnumerable)

Converts an IEnumerable to an IQueryable.

Applies to