KeyValueConfigurationCollection クラス

定義

KeyValueConfigurationElement オブジェクトのコレクションを含んでいます。

public ref class KeyValueConfigurationCollection : System::Configuration::ConfigurationElementCollection
[System.Configuration.ConfigurationCollection(typeof(System.Configuration.KeyValueConfigurationElement))]
public class KeyValueConfigurationCollection : System.Configuration.ConfigurationElementCollection
[<System.Configuration.ConfigurationCollection(typeof(System.Configuration.KeyValueConfigurationElement))>]
type KeyValueConfigurationCollection = class
    inherit ConfigurationElementCollection
Public Class KeyValueConfigurationCollection
Inherits ConfigurationElementCollection
継承
属性

次のコード例は、 型の使用方法を KeyValueConfigurationCollection 示しています。

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

注釈

このクラスはペアのコレクションを表します。各ペアは、コレクション キーと文字列値として機能する文字列で構成されます。 最初の要素はキーであるため、コレクション全体で一意である必要があります。

コンストラクター

KeyValueConfigurationCollection()

KeyValueConfigurationCollection クラスの新しいインスタンスを初期化します。

プロパティ

AddElementName

派生クラスでオーバーライドされると、ConfigurationElement での追加操作に関連付ける ConfigurationElementCollection の名前を取得または設定します。

(継承元 ConfigurationElementCollection)
AllKeys

KeyValueConfigurationCollection コレクションに格納されているすべての項目のキーを取得します。

ClearElementName

派生クラスでオーバーライドされると、ConfigurationElement での消去操作に関連付ける ConfigurationElementCollection の名前を取得または設定します。

(継承元 ConfigurationElementCollection)
CollectionType

ConfigurationElementCollection の型を取得します。

(継承元 ConfigurationElementCollection)
Count

コレクション内の要素の数を取得します。

(継承元 ConfigurationElementCollection)
CurrentConfiguration

現在の Configuration インスタンスが属している構成階層を表す最上位の ConfigurationElement インスタンスへの参照を取得します。

(継承元 ConfigurationElement)
ElementInformation

ElementInformation オブジェクトのカスタマイズできない情報と機能を格納する ConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
ElementName

派生クラスでオーバーライドされると、構成ファイル内のこの要素のコレクションを識別するために使用する名前を取得します。

(継承元 ConfigurationElementCollection)
ElementProperty

ConfigurationElementProperty オブジェクト自体を表す ConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
EmitClear

コレクションが削除されたかどうかを示す値を取得または設定します。

(継承元 ConfigurationElementCollection)
EvaluationContext

ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
HasContext

CurrentConfiguration プロパティが null であるかどうかを示す値を取得します。

(継承元 ConfigurationElement)
IsSynchronized

コレクションへのアクセスが同期されるかどうかを示す値を取得します。

(継承元 ConfigurationElementCollection)
Item[ConfigurationProperty]

この構成要素のプロパティまたは属性を取得または設定します。

(継承元 ConfigurationElement)
Item[String]

指定されたパラメーターに基づいて、KeyValueConfigurationElement オブジェクトを取得します。

LockAllAttributesExcept

ロックされている属性のコレクションを取得します。

(継承元 ConfigurationElement)
LockAllElementsExcept

ロックされている要素のコレクションを取得します。

(継承元 ConfigurationElement)
LockAttributes

ロックされている属性のコレクションを取得します。

(継承元 ConfigurationElement)
LockElements

ロックされている要素のコレクションを取得します。

(継承元 ConfigurationElement)
LockItem

要素がロックされているかどうかを示す値を取得または設定します。

(継承元 ConfigurationElement)
Properties

構成プロパティのコレクションを取得します。

RemoveElementName

派生クラスでオーバーライドされると、ConfigurationElement での削除操作に関連付ける ConfigurationElementCollection の名前を取得または設定します。

(継承元 ConfigurationElementCollection)
SyncRoot

ConfigurationElementCollection へのアクセスを同期するために使用するオブジェクトを取得します。

(継承元 ConfigurationElementCollection)
ThrowOnDuplicate

重複する KeyValueConfigurationElement オブジェクトを KeyValueConfigurationCollection コレクションに追加しようとしたときに、例外をスローするかどうかを示す値を取得します。

メソッド

Add(KeyValueConfigurationElement)

指定されたパラメーターに基づいて、KeyValueConfigurationElement オブジェクトをコレクションに追加します。

Add(String, String)

指定されたパラメーターに基づいて、KeyValueConfigurationElement オブジェクトをコレクションに追加します。

BaseAdd(ConfigurationElement)

ConfigurationElementCollection に構成要素を追加します。

(継承元 ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)

構成要素のコレクションに構成要素を追加します。

(継承元 ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)

構成要素のコレクションに構成要素を追加します。

(継承元 ConfigurationElementCollection)
BaseClear()

コレクションからすべての構成要素オブジェクトを削除します。

(継承元 ConfigurationElementCollection)
BaseGet(Int32)

指定したインデックス位置にある構成要素を取得します。

(継承元 ConfigurationElementCollection)
BaseGet(Object)

指定したキーを持つ構成要素を返します。

(継承元 ConfigurationElementCollection)
BaseGetAllKeys()

ConfigurationElementCollection に格納されているすべての構成要素のキーの配列を返します。

(継承元 ConfigurationElementCollection)
BaseGetKey(Int32)

指定したインデックス位置にある ConfigurationElement のキーを取得します。

(継承元 ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)

指定した ConfigurationElement のインデックスを示します。

(継承元 ConfigurationElementCollection)
BaseIsRemoved(Object)

指定したキーを持つ ConfigurationElementConfigurationElementCollection から削除されているかどうかを示します。

(継承元 ConfigurationElementCollection)
BaseRemove(Object)

ConfigurationElement をコレクションから削除します。

(継承元 ConfigurationElementCollection)
BaseRemoveAt(Int32)

指定したインデックス位置にある ConfigurationElement を削除します。

(継承元 ConfigurationElementCollection)
Clear()

KeyValueConfigurationCollection コレクションを空にします。

CopyTo(ConfigurationElement[], Int32)

ConfigurationElementCollection の内容を配列にコピーします。

(継承元 ConfigurationElementCollection)
CreateNewElement()

派生クラスでオーバーライドされた場合、CreateNewElement() メソッドは、新しい KeyValueConfigurationElement オブジェクトを作成します。

CreateNewElement(String)

派生クラスでオーバーライドされると、新しい ConfigurationElement を作成します。

(継承元 ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)

構成ファイルから XML を読み取ります。

(継承元 ConfigurationElement)
Equals(Object)

ConfigurationElementCollection と指定したオブジェクトを比較します。

(継承元 ConfigurationElementCollection)
GetElementKey(ConfigurationElement)

派生クラスでオーバーライドされると、指定した構成要素の要素キーを取得します。

GetEnumerator()

IEnumerator の反復処理に使用する ConfigurationElementCollection を取得します。

(継承元 ConfigurationElementCollection)
GetHashCode()

ConfigurationElementCollection インスタンスを表す一意の値を取得します。

(継承元 ConfigurationElementCollection)
GetTransformedAssemblyString(String)

指定されたアセンブリ名を変換して返します。

(継承元 ConfigurationElement)
GetTransformedTypeString(String)

指定された型名を変換して返します。

(継承元 ConfigurationElement)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
Init()

ConfigurationElement オブジェクトを初期状態に設定します。

(継承元 ConfigurationElement)
InitializeDefault()

ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。

(継承元 ConfigurationElement)
IsElementName(String)

指定した ConfigurationElementConfigurationElementCollection に存在するかどうかを示します。

(継承元 ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)

指定した ConfigurationElementConfigurationElementCollection から削除できるかどうかを示します。

(継承元 ConfigurationElementCollection)
IsModified()

派生クラスでオーバーライドされると、この ConfigurationElementCollection が最後に保存された後または読み込まれた後に、変更されているかどうかを示します。

(継承元 ConfigurationElementCollection)
IsReadOnly()

ConfigurationElementCollection オブジェクトが読み取り専用かどうかを示します。

(継承元 ConfigurationElementCollection)
ListErrors(IList)

この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティのエラーを、渡されたリストに追加します。

(継承元 ConfigurationElement)
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)

逆シリカル化中に不明な属性が発生したかどうかを示す値を取得します。

(継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

構成システムが例外をスローするようにします。

(継承元 ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)

必要なプロパティが見つからないと例外がスローされます。

(継承元 ConfigurationElement)
PostDeserialize()

逆シリアル化後に呼び出されます。

(継承元 ConfigurationElement)
PreSerialize(XmlWriter)

シリアル化前に呼び出されます。

(継承元 ConfigurationElement)
Remove(String)

KeyValueConfigurationElement オブジェクトをコレクションから削除します。

Reset(ConfigurationElement)

派生クラスでオーバーライドされると、ConfigurationElementCollection を変更されていない状態にリセットします。

(継承元 ConfigurationElementCollection)
ResetModified()

派生クラスでオーバーライドされると、IsModified() プロパティの値を false にリセットします。

(継承元 ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)

派生クラスでオーバーライドされると、構成データを構成ファイルの XML 要素に書き込みます。

(継承元 ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)

派生クラスに実装されている場合、この構成要素の外側のタグを構成ファイルに書き込みます。

(継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

プロパティを指定した値に設定します。

(継承元 ConfigurationElement)
SetReadOnly()

IsReadOnly() オブジェクトとすべてのサブ要素の ConfigurationElementCollection プロパティを設定します。

(継承元 ConfigurationElementCollection)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

構成階層の異なるレベルの構成情報をマージした効果を元に戻します。

(継承元 ConfigurationElementCollection)

明示的なインターフェイスの実装

ICollection.CopyTo(Array, Int32)

ConfigurationElementCollection を配列にコピーします。

(継承元 ConfigurationElementCollection)

拡張メソッド

Cast<TResult>(IEnumerable)

IEnumerable の要素を、指定した型にキャストします。

OfType<TResult>(IEnumerable)

指定された型に基づいて IEnumerable の要素をフィルター処理します。

AsParallel(IEnumerable)

クエリの並列化を有効にします。

AsQueryable(IEnumerable)

IEnumerableIQueryable に変換します。

適用対象