KeyValueConfigurationCollection Classe

Définition

Espace de noms:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paquet:

System.Configuration.ConfigurationManager v8.0.0

Source:

KeyValueConfigurationCollection.cs

Contient une collection d'objets 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

Héritage

Object

ConfigurationElement

ConfigurationElementCollection

KeyValueConfigurationCollection

Attributs

ConfigurationCollectionAttribute

Exemples

L’exemple de code suivant montre comment utiliser le KeyValueConfigurationCollection type .

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

Remarques

Cette classe représente une collection de paires, où chaque paire se compose d’une chaîne servant de clé de collection et d’une valeur de chaîne. Étant donné que le premier élément est une clé, il doit être unique au sein de la collection.

Constructeurs

KeyValueConfigurationCollection()

Initialise une nouvelle instance de la classe KeyValueConfigurationCollection.

Propriétés

AddElementName	Obtient ou définit le nom du ConfigurationElement à associer à l'opération d'ajout dans ConfigurationElementCollection en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
AllKeys	Obtient les clés de tous les éléments contenues dans la collection KeyValueConfigurationCollection.
ClearElementName	Obtient ou définit le nom du ConfigurationElement à associer à l'opération d'effacement dans ConfigurationElementCollection en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
CollectionType	Obtient le type de ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
Count	Obtient le nombre d’éléments de la collection. (Hérité de ConfigurationElementCollection)
CurrentConfiguration	Obtient une référence à l'instance Configuration de niveau supérieur qui représente la hiérarchie de configuration à laquelle l'instance ConfigurationElement actuelle appartient. (Hérité de ConfigurationElement)
ElementInformation	Obtient un objet ElementInformation qui contient les fonctionnalités et informations non personnalisables de l'objet ConfigurationElement. (Hérité de ConfigurationElement)
ElementName	Obtient le nom utilisé pour identifier cette collection d'éléments dans le fichier de configuration en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
ElementProperty	Obtient l'objet ConfigurationElementProperty qui représente l'objet ConfigurationElement lui-même. (Hérité de ConfigurationElement)
EmitClear	Obtient ou définit une valeur qui spécifie si la collection a été effacée. (Hérité de ConfigurationElementCollection)
EvaluationContext	Obtient l'objet ContextInformation pour l'objet ConfigurationElement. (Hérité de ConfigurationElement)
HasContext	Obtient une valeur qui indique si la propriété CurrentConfiguration a la valeur null. (Hérité de ConfigurationElement)
IsSynchronized	Obtient une valeur qui indique si l'accès à la collection est synchronisé. (Hérité de ConfigurationElementCollection)
Item[ConfigurationProperty]	Obtient ou définit une propriété ou un attribut de cet élément de configuration. (Hérité de ConfigurationElement)
Item[String]	Obtient l'objet KeyValueConfigurationElement en fonction du paramètre fourni.
LockAllAttributesExcept	Obtient la collection d'attributs verrouillés. (Hérité de ConfigurationElement)
LockAllElementsExcept	Obtient la collection d'éléments verrouillés. (Hérité de ConfigurationElement)
LockAttributes	Obtient la collection d'attributs verrouillés. (Hérité de ConfigurationElement)
LockElements	Obtient la collection d'éléments verrouillés. (Hérité de ConfigurationElement)
LockItem	Obtient ou définit une valeur indiquant si l'élément est verrouillé. (Hérité de ConfigurationElement)
Properties	Obtient une collection de propriétés de configuration.
RemoveElementName	Obtient ou définit le nom du ConfigurationElement à associer à l'opération de suppression dans ConfigurationElementCollection en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
SyncRoot	Obtient un objet utilisé pour synchroniser l'accès à ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
ThrowOnDuplicate	Obtient une valeur indiquant si une tentative d'ajout d'un objet KeyValueConfigurationElement dupliqué à la collection KeyValueConfigurationCollection provoquera la levée d'une exception.

Méthodes

Add(KeyValueConfigurationElement)	Ajoute un objet KeyValueConfigurationElement à la collection en fonction des paramètres fournis.
Add(String, String)	Ajoute un objet KeyValueConfigurationElement à la collection en fonction des paramètres fournis.
BaseAdd(ConfigurationElement)	Ajoute un élément de configuration à ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)	Ajoute un élément de configuration à la collection d'éléments de configuration. (Hérité de ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Ajoute un élément de configuration à la collection d'éléments de configuration. (Hérité de ConfigurationElementCollection)
BaseClear()	Supprime tous les objets d'élément de configuration de la collection. (Hérité de ConfigurationElementCollection)
BaseGet(Int32)	Obtient l'élément de configuration à l'emplacement d'index spécifié. (Hérité de ConfigurationElementCollection)
BaseGet(Object)	Retourne l'élément de configuration avec la clé spécifiée. (Hérité de ConfigurationElementCollection)
BaseGetAllKeys()	Retourne un tableau des clés pour tous les éléments de configuration contenus dans ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
BaseGetKey(Int32)	Obtient la clé pour le ConfigurationElement à l'emplacement d'index spécifié. (Hérité de ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indique l'index de l'élément ConfigurationElement spécifié. (Hérité de ConfigurationElementCollection)
BaseIsRemoved(Object)	Indique si l'élément ConfigurationElement avec la clé spécifiée a été supprimé de la collection ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
BaseRemove(Object)	Supprime ConfigurationElement de la collection. (Hérité de ConfigurationElementCollection)
BaseRemoveAt(Int32)	Supprime le ConfigurationElement à l'emplacement d'index spécifié. (Hérité de ConfigurationElementCollection)
Clear()	Efface la collection KeyValueConfigurationCollection.
CopyTo(ConfigurationElement[], Int32)	Copie le contenu de ConfigurationElementCollection dans un tableau. (Hérité de ConfigurationElementCollection)
CreateNewElement()	En cas de substitution dans une classe dérivée, la méthode CreateNewElement() crée un objet KeyValueConfigurationElement.
CreateNewElement(String)	Crée un nouveau ConfigurationElement en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Lit du XML à partir du fichier de configuration. (Hérité de ConfigurationElement)
Equals(Object)	Compare ConfigurationElementCollection avec l'objet spécifié. (Hérité de ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Obtient la clé d'élément pour un élément de configuration spécifié en cas de substitution dans une classe dérivée.
GetEnumerator()	Obtient un IEnumerator utilisé pour itérer au sein de ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
GetHashCode()	Obtient une valeur unique représentant l'instance de ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Retourne la version transformée du nom de l'assembly spécifié. (Hérité de ConfigurationElement)
GetTransformedTypeString(String)	Retourne la version transformée du nom de type spécifié. (Hérité de ConfigurationElement)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
Init()	Rétablit l’état initial de l’objet ConfigurationElement. (Hérité de ConfigurationElement)
InitializeDefault()	Utilisé pour initialiser un jeu de valeurs par défaut pour l'objet ConfigurationElement. (Hérité de ConfigurationElement)
IsElementName(String)	Indique si le ConfigurationElement spécifié existe dans ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indique si l'élément ConfigurationElement spécifié peut être supprimée de la collection ConfigurationElementCollection. (Hérité de ConfigurationElementCollection)
IsModified()	Indique si cette ConfigurationElementCollection a été modifiée depuis son dernier enregistrement ou chargement en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
IsReadOnly()	Indique si l'objet ConfigurationElementCollection est en lecture seule. (Hérité de ConfigurationElementCollection)
ListErrors(IList)	Ajoute les erreurs de propriété non valide dans cet objet ConfigurationElement et dans tous les sous-éléments à la liste passée. (Hérité de ConfigurationElement)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
OnDeserializeUnrecognizedAttribute(String, String)	Obtient une valeur indiquant si un attribut inconnu est rencontré pendant la désérialisation. (Hérité de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Fait en sorte que le système de configuration lève une exception. (Hérité de ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Lève une exception lorsqu'une propriété requise est introuvable. (Hérité de ConfigurationElement)
PostDeserialize()	Appelé après la désérialisation. (Hérité de ConfigurationElement)
PreSerialize(XmlWriter)	Appelé avant la sérialisation. (Hérité de ConfigurationElement)
Remove(String)	Supprime un objet KeyValueConfigurationElement de la collection.
Reset(ConfigurationElement)	Réinitialise ConfigurationElementCollection à son état non modifié en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
ResetModified()	Réinitialise la valeur de la propriété IsModified() à false en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Écrit les données de configuration d'un élément XML dans le fichier de configuration en cas de substitution dans une classe dérivée. (Hérité de ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Écrit les balises extérieures de cet élément de configuration dans le fichier de configuration lorsqu'il est implémenté dans une classe dérivée. (Hérité de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Affecte la valeur spécifiée à une propriété. (Hérité de ConfigurationElement)
SetReadOnly()	Définit la propriété IsReadOnly() pour l'objet ConfigurationElementCollection et pour tous les sous-éléments. (Hérité de ConfigurationElementCollection)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Inverse l'effet de la fusion des informations de configuration de différents niveaux de la hiérarchie de configuration. (Hérité de ConfigurationElementCollection)

Implémentations d’interfaces explicites

ICollection.CopyTo(Array, Int32)

Copie ConfigurationElementCollection dans un tableau. (Hérité de ConfigurationElementCollection)

Méthodes d’extension