KeyValueConfigurationElement クラス

定義

名前空間:

System.Configuration

アセンブリ:

System.Configuration.ConfigurationManager.dll

パッケージ:

System.Configuration.ConfigurationManager v8.0.0

ソース:

KeyValueConfigurationElement.cs

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

public ref class KeyValueConfigurationElement : System::Configuration::ConfigurationElement

public class KeyValueConfigurationElement : System.Configuration.ConfigurationElement

type KeyValueConfigurationElement = class
    inherit ConfigurationElement

Public Class KeyValueConfigurationElement
Inherits ConfigurationElement

継承

Object

ConfigurationElement

KeyValueConfigurationElement

例

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

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.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

注釈

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

コンストラクター

KeyValueConfigurationElement(String, String)

指定されたパラメーターに基づいて、KeyValueConfigurationElement クラスの新しいインスタンスを初期化します。

プロパティ

CurrentConfiguration	現在の Configuration インスタンスが属している構成階層を表す最上位の ConfigurationElement インスタンスへの参照を取得します。 (継承元 ConfigurationElement)
ElementInformation	ElementInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
ElementProperty	ConfigurationElementProperty オブジェクト自体を表す ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
EvaluationContext	ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。 (継承元 ConfigurationElement)
HasContext	CurrentConfiguration プロパティが null であるかどうかを示す値を取得します。 (継承元 ConfigurationElement)
Item[ConfigurationProperty]	この構成要素のプロパティまたは属性を取得または設定します。 (継承元 ConfigurationElement)
Item[String]	この構成要素のプロパティ、属性、または子要素を取得または設定します。 (継承元 ConfigurationElement)
Key	KeyValueConfigurationElement オブジェクトのキーを取得します。
LockAllAttributesExcept	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockAllElementsExcept	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockAttributes	ロックされている属性のコレクションを取得します。 (継承元 ConfigurationElement)
LockElements	ロックされている要素のコレクションを取得します。 (継承元 ConfigurationElement)
LockItem	要素がロックされているかどうかを示す値を取得または設定します。 (継承元 ConfigurationElement)
Properties	プロパティのコレクションを取得します。
Value	KeyValueConfigurationElement オブジェクトの値を取得または設定します。

メソッド

DeserializeElement(XmlReader, Boolean)	構成ファイルから XML を読み取ります。 (継承元 ConfigurationElement)
Equals(Object)	現在の ConfigurationElement インスタンスを、指定したオブジェクトと比較します。 (継承元 ConfigurationElement)
GetHashCode()	現在の ConfigurationElement インスタンスを表す一意の値を取得します。 (継承元 ConfigurationElement)
GetTransformedAssemblyString(String)	指定されたアセンブリ名を変換して返します。 (継承元 ConfigurationElement)
GetTransformedTypeString(String)	指定された型名を変換して返します。 (継承元 ConfigurationElement)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Init()	KeyValueConfigurationElement オブジェクトを初期状態に設定します。
InitializeDefault()	ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。 (継承元 ConfigurationElement)
IsModified()	派生クラスに実装された場合、この構成要素が最後の保存または読み込み以降に変更されたかどうかを示します。 (継承元 ConfigurationElement)
IsReadOnly()	ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。 (継承元 ConfigurationElement)
ListErrors(IList)	この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。 (継承元 ConfigurationElement)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)	逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	逆シリカル化中に不明な要素が発生したかどうかを示す値を取得します。 (継承元 ConfigurationElement)
OnRequiredPropertyNotFound(String)	必要なプロパティが見つからないと例外がスローされます。 (継承元 ConfigurationElement)
PostDeserialize()	逆シリアル化後に呼び出されます。 (継承元 ConfigurationElement)
PreSerialize(XmlWriter)	シリアル化前に呼び出されます。 (継承元 ConfigurationElement)
Reset(ConfigurationElement)	ConfigurationElement オブジェクトの内部状態 (ロックやプロパティ コレクションなど) をリセットします。 (継承元 ConfigurationElement)
ResetModified()	IsModified() メソッドの値が派生クラスに実装されたときに、false にリセットします。 (継承元 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	派生クラスに実装されている場合、この構成要素の内容を構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。 (継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	プロパティを指定した値に設定します。 (継承元 ConfigurationElement)
SetReadOnly()	IsReadOnly() オブジェクトおよびすべてのサブ要素に ConfigurationElement プロパティを設定します。 (継承元 ConfigurationElement)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	保存しないすべての値を削除するには、ConfigurationElement オブジェクトを変更します。 (継承元 ConfigurationElement)

こちらもご覧ください

• ConfigurationElement