Export (0) Print
Expand All

KeyValueConfigurationCollection Class

Note: This class is new in the .NET Framework version 2.0.

Contains a collection of KeyValueConfigurationElement objects.

Namespace: System.Configuration
Assembly: System.Configuration (in system.configuration.dll)

public class KeyValueConfigurationCollection : ConfigurationElementCollection
public class KeyValueConfigurationCollection extends ConfigurationElementCollection
public class KeyValueConfigurationCollection extends ConfigurationElementCollection

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.

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


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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft