KeyValueConfigurationElement Classe

Définition

Espace de noms:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Paquet:

System.Configuration.ConfigurationManager v8.0.0

Source:

KeyValueConfigurationElement.cs

Représente un élément de configuration qui contient une paire clé/valeur.

public ref class KeyValueConfigurationElement : System::Configuration::ConfigurationElement

public class KeyValueConfigurationElement : System.Configuration.ConfigurationElement

type KeyValueConfigurationElement = class
    inherit ConfigurationElement

Public Class KeyValueConfigurationElement
Inherits ConfigurationElement

Héritage

Object

ConfigurationElement

KeyValueConfigurationElement

Exemples

L’exemple de code suivant montre comment utiliser les membres de la KeyValueConfigurationElement classe .

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

L’objet KeyValueConfigurationElement hérite de la ConfigurationElement classe de base. L’objet ConfigurationElement représente un élément dans un fichier de configuration. L’objet KeyValueConfigurationElement peut appartenir à une KeyValueConfigurationCollection collection.

Constructeurs

KeyValueConfigurationElement(String, String)

Initialise une nouvelle instance de la classe KeyValueConfigurationElement en fonction des paramètres fournis.

Propriétés

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)
ElementProperty	Obtient l'objet ConfigurationElementProperty qui représente l'objet ConfigurationElement lui-même. (Hérité de ConfigurationElement)
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)
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 ou définit une propriété, un attribut ou un élément enfant de cet élément de configuration. (Hérité de ConfigurationElement)
Key	Obtient la clé de l’objet KeyValueConfigurationElement.
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 la collection de propriétés.
Value	Obtient ou définit la valeur de l’objet KeyValueConfigurationElement.

Méthodes

DeserializeElement(XmlReader, Boolean)	Lit du XML à partir du fichier de configuration. (Hérité de ConfigurationElement)
Equals(Object)	Compare l’instance de ConfigurationElement actuelle à l’objet spécifié. (Hérité de ConfigurationElement)
GetHashCode()	Obtient une valeur unique représentant l'instance actuelle de ConfigurationElement. (Hérité de ConfigurationElement)
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 KeyValueConfigurationElement.
InitializeDefault()	Utilisé pour initialiser un jeu de valeurs par défaut pour l'objet ConfigurationElement. (Hérité de ConfigurationElement)
IsModified()	Indique si cet élément de configuration a été modifié depuis son dernier enregistrement ou chargement lorsqu'il est implémenté dans une classe dérivée. (Hérité de ConfigurationElement)
IsReadOnly()	Obtient une valeur indiquant si l’objet ConfigurationElement est en lecture seule. (Hérité de ConfigurationElement)
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)	Obtient une valeur indiquant si un élément inconnu est rencontré pendant la désérialisation. (Hérité de ConfigurationElement)
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)
Reset(ConfigurationElement)	Rétablit l'état interne de l'objet ConfigurationElement, y compris les verrouillages et les collections de propriétés. (Hérité de ConfigurationElement)
ResetModified()	Réinitialise la valeur de la méthode IsModified() à false en cas d’implémentation dans une classe dérivée. (Hérité de ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	Écrit le contenu 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)
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 ConfigurationElement et tous les sous-éléments. (Hérité de ConfigurationElement)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifie l'objet ConfigurationElement pour supprimer toutes les valeurs qui ne doivent pas être enregistrées. (Hérité de ConfigurationElement)

Voir aussi

• ConfigurationElement