KeyValueConfigurationCollection Klasse

Definition

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paket:

System.Configuration.ConfigurationManager v8.0.0

Quelle:

KeyValueConfigurationCollection.cs

Enthält eine Auflistung von KeyValueConfigurationElement-Objekten.

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

Vererbung

Object

ConfigurationElement

ConfigurationElementCollection

KeyValueConfigurationCollection

Attribute

ConfigurationCollectionAttribute

Beispiele

Im folgenden Codebeispiel wird die Verwendung des Typs KeyValueConfigurationCollection veranschaulicht.

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

Hinweise

Diese Klasse stellt eine Auflistung von Paaren dar, wobei jedes Paar aus einer Zeichenfolge besteht, die als Auflistungsschlüssel und Zeichenfolgenwert dient. Da das erste Element ein Schlüssel ist, muss es für die Gesamteinlistung eindeutig sein.

Konstruktoren

KeyValueConfigurationCollection()

Initialisiert eine neue Instanz der KeyValueConfigurationCollection-Klasse.

Eigenschaften

AddElementName	Ruft den Namen des ConfigurationElement ab, das beim Überschreiben in einer abgeleiteten Klasse dem Hinzufügevorgang in der ConfigurationElementCollection zugeordnet werden soll, oder legt diesen fest. (Geerbt von ConfigurationElementCollection)
AllKeys	Ruft die Schlüssel zu allen in der KeyValueConfigurationCollection-Auflistung enthaltenen Elementen ab.
ClearElementName	Ruft den Namen für das ConfigurationElement ab, das beim Überschreiben in einer abgeleiteten Klasse dem Löschvorgang in der ConfigurationElementCollection zugeordnet werden soll, oder legt diesen fest. (Geerbt von ConfigurationElementCollection)
CollectionType	Ruft den Typ des ConfigurationElementCollection ab. (Geerbt von ConfigurationElementCollection)
Count	Ruft die Anzahl der Elemente in der Auflistung ab. (Geerbt von ConfigurationElementCollection)
CurrentConfiguration	Ruft einen Verweis auf die Configuration-Instanz der obersten Ebene ab, die die Konfigurationshierarchie darstellt, zu der die aktuelle ConfigurationElement-Instanz gehört. (Geerbt von ConfigurationElement)
ElementInformation	Ruft ein ElementInformation-Objekt ab, das die nicht anpassbaren Informationen und Funktionen des ConfigurationElement-Objekts enthält. (Geerbt von ConfigurationElement)
ElementName	Ruft den Namen ab, der beim Überschreiben in einer abgeleiteten Klasse für die Identifikation dieser Auflistung mit Elementen in der Konfigurationsdatei verwendet wird. (Geerbt von ConfigurationElementCollection)
ElementProperty	Ruft das ConfigurationElementProperty-Objekt ab, das das ConfigurationElement-Objekt selbst darstellt. (Geerbt von ConfigurationElement)
EmitClear	Ruft einen Wert ab, der angibt, ob die Auflistung gelöscht wurde, oder legt diesen fest. (Geerbt von ConfigurationElementCollection)
EvaluationContext	Ruft das ContextInformation-Objekt für das ConfigurationElement-Objekt ab. (Geerbt von ConfigurationElement)
HasContext	Ruft einen Wert ab, der angibt, ob die CurrentConfiguration-Eigenschaft null ist. (Geerbt von ConfigurationElement)
IsSynchronized	Ruft einen Wert ab, der angibt, ob der Zugriff auf die Auflistung synchronisiert ist. (Geerbt von ConfigurationElementCollection)
Item[ConfigurationProperty]	Ruft eine Eigenschaft oder ein Attribut dieses Konfigurationselements ab oder legt diese bzw. dieses fest. (Geerbt von ConfigurationElement)
Item[String]	Ruft das KeyValueConfigurationElement-Objekt auf der Grundlage des angegebenen Parameters ab.
LockAllAttributesExcept	Ruft die Auflistung gesperrter Attribute ab. (Geerbt von ConfigurationElement)
LockAllElementsExcept	Ruft die Auflistung gesperrter Elemente ab. (Geerbt von ConfigurationElement)
LockAttributes	Ruft die Auflistung gesperrter Attribute ab. (Geerbt von ConfigurationElement)
LockElements	Ruft die Auflistung gesperrter Elemente ab. (Geerbt von ConfigurationElement)
LockItem	Ruft einen Wert ab, der angibt, ob das Element gesperrt ist, oder legt diesen fest. (Geerbt von ConfigurationElement)
Properties	Ruft eine Auflistung von Konfigurationseigenschaften ab.
RemoveElementName	Ruft den Namen des ConfigurationElement ab, das beim Überschreiben in einer abgeleiteten Klasse dem Entfernungsvorgang in der ConfigurationElementCollection zugeordnet werden soll, oder legt diesen fest. (Geerbt von ConfigurationElementCollection)
SyncRoot	Ruft ein Objekt ab, das zum Synchronisieren des Zugriffs auf ConfigurationElementCollection verwendet wird. (Geerbt von ConfigurationElementCollection)
ThrowOnDuplicate	Ruft einen Wert ab, der angibt, ob der Versuch, der KeyValueConfigurationElement-Auflistung ein doppeltes KeyValueConfigurationCollection-Objekt hinzuzufügen, eine Ausnahme auslöst.

Methoden

Add(KeyValueConfigurationElement)	Fügt der auf den bereitgestellten Parametern basierenden Auflistung ein KeyValueConfigurationElement-Objekt hinzu.
Add(String, String)	Fügt der auf den bereitgestellten Parametern basierenden Auflistung ein KeyValueConfigurationElement-Objekt hinzu.
BaseAdd(ConfigurationElement)	Fügt der ConfigurationElementCollection ein Konfigurationselement hinzu. (Geerbt von ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)	Fügt der Konfigurationselementauflistung ein Konfigurationselement hinzu. (Geerbt von ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Fügt der Konfigurationselementauflistung ein Konfigurationselement hinzu. (Geerbt von ConfigurationElementCollection)
BaseClear()	Entfernt alle Konfigurationselementobjekte aus der Auflistung. (Geerbt von ConfigurationElementCollection)
BaseGet(Int32)	Ruft das Konfigurationselement am angegebenen Index ab. (Geerbt von ConfigurationElementCollection)
BaseGet(Object)	Gibt das Konfigurationselement mit dem angegebenen Schlüssel zurück. (Geerbt von ConfigurationElementCollection)
BaseGetAllKeys()	Gibt ein Array der Schlüssel für alle Konfigurationselemente in der ConfigurationElementCollection zurück. (Geerbt von ConfigurationElementCollection)
BaseGetKey(Int32)	Ruft den Schlüssel für das ConfigurationElement an der angegebenen Indexposition ab. (Geerbt von ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Gibt den Index der angegebenen ConfigurationElement an. (Geerbt von ConfigurationElementCollection)
BaseIsRemoved(Object)	Gibt an, ob das ConfigurationElement mit dem angegebenen Schlüssel aus der ConfigurationElementCollection entfernt worden ist. (Geerbt von ConfigurationElementCollection)
BaseRemove(Object)	Entfernt ein ConfigurationElement aus der Auflistung. (Geerbt von ConfigurationElementCollection)
BaseRemoveAt(Int32)	Entfernt das ConfigurationElement an der angegebenen Indexposition. (Geerbt von ConfigurationElementCollection)
Clear()	Löscht die KeyValueConfigurationCollection-Auflistung.
CopyTo(ConfigurationElement[], Int32)	Kopiert den Inhalt der ConfigurationElementCollection in ein Array. (Geerbt von ConfigurationElementCollection)
CreateNewElement()	Wenn sie in einer abgeleiteten Klasse überschrieben wird, erstellt die CreateNewElement()-Methode ein neues KeyValueConfigurationElement-Objekt.
CreateNewElement(String)	Erstellt ein neues ConfigurationElement, wenn es in einer abgeleiteten Klasse überschrieben wurde. (Geerbt von ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Liest XML aus der Konfigurationsdatei. (Geerbt von ConfigurationElement)
Equals(Object)	Vergleicht die ConfigurationElementCollection mit dem angegebenen Objekt. (Geerbt von ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Ruft beim Überschreiben in einer abgeleiteten Klasse den Elementschlüssel für ein angegebenes Konfigurationselement ab.
GetEnumerator()	Ruft einen IEnumerator ab, der zum Durchlaufen von ConfigurationElementCollection verwendet wird. (Geerbt von ConfigurationElementCollection)
GetHashCode()	Ruft einen eindeutigen Wert ab, der die ConfigurationElementCollection-Instanz darstellt. (Geerbt von ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Gibt die transformierte Version des angegebenen Assemblynamens zurück. (Geerbt von ConfigurationElement)
GetTransformedTypeString(String)	Gibt die transformierte Version des angegebenen Typnamens zurück. (Geerbt von ConfigurationElement)
GetType()	Ruft den Type der aktuellen Instanz ab. (Geerbt von Object)
Init()	Legt für das ConfigurationElement-Objekt den Ausgangszustand fest. (Geerbt von ConfigurationElement)
InitializeDefault()	Wird verwendet, um einen Standardsatz von Werten für das ConfigurationElement-Objekt zu initialisieren. (Geerbt von ConfigurationElement)
IsElementName(String)	Gibt an, ob das angegebene ConfigurationElement in der ConfigurationElementCollection vorhanden ist. (Geerbt von ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Gibt an, ob das angegebene ConfigurationElement aus der ConfigurationElementCollection entfernt werden kann. (Geerbt von ConfigurationElementCollection)
IsModified()	Gibt an, ob diese ConfigurationElementCollection geändert wurde, seit sie zuletzt gespeichert oder geladen wurde, wenn sie in einer abgeleiteten Klasse überschrieben wurde. (Geerbt von ConfigurationElementCollection)
IsReadOnly()	Gibt an, ob das ConfigurationElementCollection-Objekt schreibgeschützt ist. (Geerbt von ConfigurationElementCollection)
ListErrors(IList)	Fügt die Fehler über ungültige Eigenschaften in diesem ConfigurationElement-Objekt und in allen Unterelementen der übergebenen Liste hinzu. (Geerbt von ConfigurationElement)
MemberwiseClone()	Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object)
OnDeserializeUnrecognizedAttribute(String, String)	Ruft einen Wert ab, der angibt, ob während der Deserialisierung ein unbekanntes Attribut aufgetreten ist. (Geerbt von ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Bewirkt, dass das Konfigurationssystem eine Ausnahme auslöst. (Geerbt von ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Löst eine Ausnahme aus, wenn eine erforderliche Eigenschaft nicht gefunden wird. (Geerbt von ConfigurationElement)
PostDeserialize()	Wird nach der Deserialisierung aufgerufen. (Geerbt von ConfigurationElement)
PreSerialize(XmlWriter)	Wird vor der Serialisierung aufgerufen. (Geerbt von ConfigurationElement)
Remove(String)	Entfernt ein KeyValueConfigurationElement-Objekt aus der Auflistung.
Reset(ConfigurationElement)	Setzt die ConfigurationElementCollection auf ihren unveränderten Zustand zurück, wenn sie in einer abgeleiteten Klasse überschrieben wurde. (Geerbt von ConfigurationElementCollection)
ResetModified()	Setzt den Wert der IsModified()-Eigenschaft auf false zurück, wenn er in einer abgeleiteten Klasse überschrieben wurde. (Geerbt von ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Schreibt die Konfigurationsdaten in ein XML-Element in der Konfigurationsdatei, wenn sie in einer abgeleiteten Klasse überschrieben wurden. (Geerbt von ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Schreibt bei Implementierung in einer abgeleiteten Klasse die äußeren Tags dieses Konfigurationselements in die Konfigurationsdatei. (Geerbt von ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Legt eine Eigenschaft auf den angegebenen Wert fest. (Geerbt von ConfigurationElement)
SetReadOnly()	Legt die IsReadOnly()-Eigenschaft für das ConfigurationElementCollection-Objekt und alle Unterelemente fest. (Geerbt von ConfigurationElementCollection)
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Kehrt die Auswirkungen der Zusammenführung von Konfigurationsinformationen aus verschiedenen Ebenen der Konfigurationshierarchie um. (Geerbt von ConfigurationElementCollection)

Explizite Schnittstellenimplementierungen

ICollection.CopyTo(Array, Int32)

Kopiert das ConfigurationElementCollection in ein Array. (Geerbt von ConfigurationElementCollection)

Erweiterungsmethoden