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	取得 ConfigurationElement 物件的 ContextInformation 物件。 (繼承來源 ConfigurationElement)
HasContext	取得值，指出 CurrentConfiguration 屬性是否為 null。 (繼承來源 ConfigurationElement)
Item[ConfigurationProperty]	取得或設定此組態項目的屬性 (Property) 或屬性 (Attribute)。 (繼承來源 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)	取得值，指出在還原序列化程序中是否遇到未知的屬性 (Attribute)。 (繼承來源 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	取得值，指出在還原序列化程序中是否遇到未知的項目。 (繼承來源 ConfigurationElement)
OnRequiredPropertyNotFound(String)	在找不到必要的屬性時擲回例外狀況 (Exception)。 (繼承來源 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