KeyValueConfigurationCollection Clase

Definición

Espacio de nombres:

System.Configuration

Ensamblado:

System.Configuration.ConfigurationManager.dll

Paquete:

System.Configuration.ConfigurationManager v8.0.0

Source:

KeyValueConfigurationCollection.cs

Contiene una colección de objetos 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

Herencia

Object

ConfigurationElement

ConfigurationElementCollection

KeyValueConfigurationCollection

Atributos

ConfigurationCollectionAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar el KeyValueConfigurationCollection tipo .

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

Comentarios

Esta clase representa una colección de pares, donde cada par consta de una cadena que actúa como clave de colección y un valor de cadena. Dado que el primer elemento es una clave, debe ser único en toda la colección.

Constructores

KeyValueConfigurationCollection()

Inicializa una nueva instancia de la clase KeyValueConfigurationCollection.

Propiedades

AddElementName	Obtiene o establece el nombre del objeto ConfigurationElement que se va a asociar a la operación de adición en la colección ConfigurationElementCollection cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
AllKeys	Obtiene las claves de todos los elementos incluidos en la colección KeyValueConfigurationCollection.
ClearElementName	Obtiene o establece el nombre del objeto ConfigurationElement que se va a asociar a la operación de borrado en la colección ConfigurationElementCollection cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
CollectionType	Obtiene el tipo de ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
Count	Obtiene el número de elementos de la colección. (Heredado de ConfigurationElementCollection)
CurrentConfiguration	Obtiene una referencia a la instancia de Configuration de nivel superior que representa la jerarquía de configuración a la que pertenece la instancia actual de ConfigurationElement. (Heredado de ConfigurationElement)
ElementInformation	Obtiene un objeto ElementInformation que contiene la funcionalidad e información no personalizable del objeto ConfigurationElement. (Heredado de ConfigurationElement)
ElementName	Obtiene el nombre que se utiliza para identificar esta colección de elementos en el archivo de configuración cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
ElementProperty	Obtiene el objeto ConfigurationElementProperty que representa al propio objeto ConfigurationElement. (Heredado de ConfigurationElement)
EmitClear	Obtiene o establece un valor que especifica si se ha borrado la colección. (Heredado de ConfigurationElementCollection)
EvaluationContext	Obtiene el objeto ContextInformation para el objeto ConfigurationElement. (Heredado de ConfigurationElement)
HasContext	Obtiene un valor que indica si la propiedad CurrentConfiguration es null. (Heredado de ConfigurationElement)
IsSynchronized	Obtiene un valor que indica si se sincroniza el acceso a la recopilación. (Heredado de ConfigurationElementCollection)
Item[ConfigurationProperty]	Obtiene o establece una propiedad o atributo de este elemento de configuración. (Heredado de ConfigurationElement)
Item[String]	Obtiene el objeto KeyValueConfigurationElement basándose en el parámetro proporcionado.
LockAllAttributesExcept	Obtiene la colección de atributos bloqueados. (Heredado de ConfigurationElement)
LockAllElementsExcept	Obtiene la colección de elementos bloqueados. (Heredado de ConfigurationElement)
LockAttributes	Obtiene la colección de atributos bloqueados. (Heredado de ConfigurationElement)
LockElements	Obtiene la colección de elementos bloqueados. (Heredado de ConfigurationElement)
LockItem	Obtiene o establece un valor que indica si el elemento está bloqueado. (Heredado de ConfigurationElement)
Properties	Obtiene una colección de propiedades de configuración.
RemoveElementName	Obtiene o establece el nombre del objeto ConfigurationElement que se va a asociar a la operación de eliminación en la colección ConfigurationElementCollection cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
SyncRoot	Obtiene un objeto que se utiliza para sincronizar el acceso a la colección ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
ThrowOnDuplicate	Obtiene un valor que indica si el intento de agregar un objeto KeyValueConfigurationElement duplicado a la colección KeyValueConfigurationCollection va a provocar que se inicie una excepción.

Métodos

Add(KeyValueConfigurationElement)	Agrega un objeto KeyValueConfigurationElement a la colección basándose en los parámetros proporcionados.
Add(String, String)	Agrega un objeto KeyValueConfigurationElement a la colección basándose en los parámetros proporcionados.
BaseAdd(ConfigurationElement)	Agrega un elemento de configuración a la colección ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)	Agrega un elemento de configuración a la colección de elementos de configuración. (Heredado de ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Agrega un elemento de configuración a la colección de elementos de configuración. (Heredado de ConfigurationElementCollection)
BaseClear()	Quita todos los objetos de elemento de configuración de la colección. (Heredado de ConfigurationElementCollection)
BaseGet(Int32)	Obtiene el elemento de configuración en la ubicación de índice especificada. (Heredado de ConfigurationElementCollection)
BaseGet(Object)	Devuelve el elemento de configuración con la clave especificada. (Heredado de ConfigurationElementCollection)
BaseGetAllKeys()	Devuelve una matriz de claves para todos los elementos de configuración incluidos en la colección ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
BaseGetKey(Int32)	Obtiene la clave para el objeto ConfigurationElement en la ubicación de índice especificada. (Heredado de ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indica el índice del objeto ConfigurationElement especificado. (Heredado de ConfigurationElementCollection)
BaseIsRemoved(Object)	Indica si el objeto ConfigurationElement con la clave especificada se ha quitado de la colección ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
BaseRemove(Object)	Quita un objeto ConfigurationElement de la colección. (Heredado de ConfigurationElementCollection)
BaseRemoveAt(Int32)	Quita el objeto ConfigurationElement en la ubicación de índice especificada. (Heredado de ConfigurationElementCollection)
Clear()	Borra la colección KeyValueConfigurationCollection.
CopyTo(ConfigurationElement[], Int32)	Copia el contenido de la colección ConfigurationElementCollection en una matriz. (Heredado de ConfigurationElementCollection)
CreateNewElement()	Cuando se reemplaza en una clase derivada, el método CreateNewElement() crea un nuevo objeto KeyValueConfigurationElement.
CreateNewElement(String)	Crea un nuevo objeto ConfigurationElement cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Lee XML del archivo de configuración. (Heredado de ConfigurationElement)
Equals(Object)	Compara la colección ConfigurationElementCollection con el objeto especificado. (Heredado de ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Cuando se reemplaza en una clase derivada, obtiene la clave de elemento para un elemento de configuración especificado.
GetEnumerator()	Obtiene una interfaz IEnumerator que se utiliza para recorrer en iteración la colección ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
GetHashCode()	Obtiene un valor único que representa la instancia de ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Devuelve la versión transformada del nombre de ensamblado especificado. (Heredado de ConfigurationElement)
GetTransformedTypeString(String)	Devuelve la versión transformada del nombre de tipo especificado. (Heredado de ConfigurationElement)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
Init()	Establece el objeto ConfigurationElement en su estado inicial. (Heredado de ConfigurationElement)
InitializeDefault()	Se utiliza para inicializar un conjunto predeterminado de valores para el objeto ConfigurationElement. (Heredado de ConfigurationElement)
IsElementName(String)	Indica si el objeto ConfigurationElement especificado existe en la colección ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indica si la ConfigurationElement se puede quitar de ConfigurationElementCollection. (Heredado de ConfigurationElementCollection)
IsModified()	Indica si se ha modificado esta colección ConfigurationElementCollection desde la última vez en que se guardo o cargó al reemplazarla en una clase derivada. (Heredado de ConfigurationElementCollection)
IsReadOnly()	Indica si la el objeto ConfigurationElementCollection es de solo lectura. (Heredado de ConfigurationElementCollection)
ListErrors(IList)	Agrega a la lista que se pasa los errores de propiedad no válida que hay en este objeto ConfigurationElement y en todos los subelementos. (Heredado de ConfigurationElement)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
OnDeserializeUnrecognizedAttribute(String, String)	Obtiene un valor que indica si se ha encontrado un atributo desconocido durante la deserialización. (Heredado de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Hace que el sistema de configuración produzca una excepción. (Heredado de ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Se inicia una excepción cuando no se encuentra una propiedad necesaria. (Heredado de ConfigurationElement)
PostDeserialize()	Se llama a este método después de la deserialización. (Heredado de ConfigurationElement)
PreSerialize(XmlWriter)	Se llama a este método antes de la serialización. (Heredado de ConfigurationElement)
Remove(String)	Quita un objeto KeyValueConfigurationElement de la colección.
Reset(ConfigurationElement)	Restablece la colección ConfigurationElementCollection a su estado sin modificaciones cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
ResetModified()	Restablece el valor de la propiedad IsModified() en false cuando se invalida en una clase derivada. (Heredado de ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Escribe los datos de configuración en un elemento XML del archivo de configuración cuando se reemplaza en una clase derivada. (Heredado de ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Escribe las etiquetas externas de este elemento de configuración en el archivo de configuración cuando se implementa en una clase derivada. (Heredado de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Establece una propiedad en el valor especificado. (Heredado de ConfigurationElement)
SetReadOnly()	Establece la propiedad IsReadOnly() para el objeto ConfigurationElementCollection y para todos los subelementos. (Heredado de ConfigurationElementCollection)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Invierte el efecto de combinar la información de configuración de distintos niveles de la jerarquía de configuración. (Heredado de ConfigurationElementCollection)

Implementaciones de interfaz explícitas

ICollection.CopyTo(Array, Int32)

Copia la colección ConfigurationElementCollection en una matriz. (Heredado de ConfigurationElementCollection)

Métodos de extensión