共用方式為


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

取得 ConfigurationElement 物件的 ContextInformation 物件。

(繼承來源 ConfigurationElement)
HasContext

取得值,指出 CurrentConfiguration 屬性是否為 null

(繼承來源 ConfigurationElement)
IsSynchronized

取得值,指出是否同步存取集合。

(繼承來源 ConfigurationElementCollection)
Item[ConfigurationProperty]

取得或設定此組態項目的屬性 (Property) 或屬性 (Attribute)。

(繼承來源 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)

指出是否已從 ConfigurationElement 移除具有指定索引鍵的 ConfigurationElementCollection

(繼承來源 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)

指出指定的 ConfigurationElement 是否存在於 ConfigurationElementCollection 中。

(繼承來源 ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)

指出指定的 ConfigurationElement 是否可從 ConfigurationElementCollection 移除。

(繼承來源 ConfigurationElementCollection)
IsModified()

在衍生類別中覆寫時,指出這個 ConfigurationElementCollection 自上次儲存或載入後是否已修改。

(繼承來源 ConfigurationElementCollection)
IsReadOnly()

指出 ConfigurationElementCollection 物件是否為唯讀。

(繼承來源 ConfigurationElementCollection)
ListErrors(IList)

將這個 ConfigurationElement 物件中和所有子項目中的無效屬性錯誤加入傳遞的清單。

(繼承來源 ConfigurationElement)
MemberwiseClone()

建立目前 Object 的淺層複製。

(繼承來源 Object)
OnDeserializeUnrecognizedAttribute(String, String)

取得值,指出在還原序列化程序中是否遇到未知的屬性 (Attribute)。

(繼承來源 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

導致組態系統擲回例外狀況。

(繼承來源 ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)

在找不到必要的屬性時擲回例外狀況 (Exception)。

(繼承來源 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)

IEnumerable 轉換成 IQueryable

適用於