KeyValueConfigurationElement クラス

.NET Framework クラス ライブラリ リファレンス

KeyValueConfigurationElement クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

キーと値のペアを格納する構成要素を表します。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public Class KeyValueConfigurationElement
    Inherits ConfigurationElement

Visual Basic (使用法)

Dim instance As KeyValueConfigurationElement

C#

public class KeyValueConfigurationElement :
 ConfigurationElement

C++

public ref class KeyValueConfigurationElement
 : public ConfigurationElement

J#

public class KeyValueConfigurationElement extends
 ConfigurationElement

JScript

public class KeyValueConfigurationElement extends
 ConfigurationElement

解説

KeyValueConfigurationElement オブジェクトは ConfigurationElement 基本クラスから継承します。ConfigurationElement オブジェクトは、構成ファイル内の要素を表します。KeyValueConfigurationElement オブジェクトは、KeyValueConfigurationCollection コレクションに属することができます。

使用例

KeyValueConfigurationElement クラスのメンバを使用する方法を次のコード例に示します。

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

継承階層

System.Object
   System.Configuration.ConfigurationElement
    System.Configuration.KeyValueConfigurationElement

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
KeyValueConfigurationElement メンバ
System.Configuration 名前空間
ConfigurationElement クラス
その他の技術情報
appSettings 要素 (全般設定スキーマ)