KeyValueConfigurationCollection Classe

Definição

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Pacote:

System.Configuration.ConfigurationManager v8.0.0

Origem:

KeyValueConfigurationCollection.cs

Contém uma coleção 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

Herança

Object

ConfigurationElement

ConfigurationElementCollection

KeyValueConfigurationCollection

Atributos

ConfigurationCollectionAttribute

Exemplos

O exemplo de código a seguir demonstra como usar o 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

Comentários

Essa classe representa uma coleção de pares, em que cada par consiste em uma cadeia de caracteres servindo como uma chave de coleção e um valor de cadeia de caracteres. Como o primeiro elemento é uma chave, ele deve ser exclusivo em toda a coleção.

Construtores

KeyValueConfigurationCollection()

Inicializa uma nova instância da classe KeyValueConfigurationCollection.

Propriedades

AddElementName	Obtém ou define o nome do ConfigurationElement a ser associado à operação de adição no ConfigurationElementCollection quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
AllKeys	Obtém as chaves para todos os itens contidos na coleção KeyValueConfigurationCollection.
ClearElementName	Obtém ou define o nome do ConfigurationElement a ser associado à operação de limpeza no ConfigurationElementCollection quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
CollectionType	Obtém o tipo do ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
Count	Obtém o número de elementos na coleção. (Herdado de ConfigurationElementCollection)
CurrentConfiguration	Obtém uma referência para a instância Configuration de nível superior que representa a hierarquia de configuração à qual a instância atual ConfigurationElement pertence. (Herdado de ConfigurationElement)
ElementInformation	Obtém um objeto ElementInformation que contém as informações não personalizáveis e a funcionalidade do objeto ConfigurationElement. (Herdado de ConfigurationElement)
ElementName	Obtém o nome usado para identificar esta coleção de elementos no arquivo de configuração quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
ElementProperty	Obtém o objeto ConfigurationElementProperty que representa o próprio objeto ConfigurationElement. (Herdado de ConfigurationElement)
EmitClear	Obtém ou define um valor que especifica se a coleção foi limpa. (Herdado de ConfigurationElementCollection)
EvaluationContext	Obtém o objeto ContextInformation para o objeto ConfigurationElement. (Herdado de ConfigurationElement)
HasContext	Obtém um valor que indica se a propriedade CurrentConfiguration é null. (Herdado de ConfigurationElement)
IsSynchronized	Obtém um valor que indica se o acesso à coleção é sincronizado. (Herdado de ConfigurationElementCollection)
Item[ConfigurationProperty]	Obtém ou define uma propriedade ou um atributo desse elemento de configuração. (Herdado de ConfigurationElement)
Item[String]	Obtém o objeto KeyValueConfigurationElement com base no parâmetro fornecido.
LockAllAttributesExcept	Obtém a coleção de atributos bloqueados. (Herdado de ConfigurationElement)
LockAllElementsExcept	Obtém a coleção de elementos bloqueados. (Herdado de ConfigurationElement)
LockAttributes	Obtém a coleção de atributos bloqueados. (Herdado de ConfigurationElement)
LockElements	Obtém a coleção de elementos bloqueados. (Herdado de ConfigurationElement)
LockItem	Obtém ou define um valor que indica se o elemento está bloqueado. (Herdado de ConfigurationElement)
Properties	Obtém uma coleção de propriedades de configuração.
RemoveElementName	Obtém ou define o nome do ConfigurationElement a ser associado à operação de remoção no ConfigurationElementCollection quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
SyncRoot	Obtém um objeto usado para sincronizar o acesso ao ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
ThrowOnDuplicate	Obtém um valor que indica se uma tentativa de adicionar um objeto KeyValueConfigurationElement duplicado à coleção KeyValueConfigurationCollection fará com que uma exceção seja lançada.

Métodos

Add(KeyValueConfigurationElement)	Adiciona um objeto KeyValueConfigurationElement à coleção com base nos parâmetros fornecidos.
Add(String, String)	Adiciona um objeto KeyValueConfigurationElement à coleção com base nos parâmetros fornecidos.
BaseAdd(ConfigurationElement)	Adiciona um elemento de configuração ao ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)	Adiciona um elemento de configuração à coleção de elementos de configuração. (Herdado de ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Adiciona um elemento de configuração à coleção de elementos de configuração. (Herdado de ConfigurationElementCollection)
BaseClear()	Remove todos os objetos de elemento de configuração da coleção. (Herdado de ConfigurationElementCollection)
BaseGet(Int32)	Obtém o elemento de configuração no local do índice especificado. (Herdado de ConfigurationElementCollection)
BaseGet(Object)	Retorna o elemento de configuração com a chave especificada. (Herdado de ConfigurationElementCollection)
BaseGetAllKeys()	Retorna uma matriz das chaves para todos os elementos de configuração contidos no ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
BaseGetKey(Int32)	Obtém a chave para o ConfigurationElement no local do índice especificado. (Herdado de ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Indica o índice do ConfigurationElement especificado. (Herdado de ConfigurationElementCollection)
BaseIsRemoved(Object)	Indica se o ConfigurationElement com a chave especificada foi removido do ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
BaseRemove(Object)	Remove um ConfigurationElement da coleção. (Herdado de ConfigurationElementCollection)
BaseRemoveAt(Int32)	Remove o ConfigurationElement no local de índice especificado. (Herdado de ConfigurationElementCollection)
Clear()	Limpa a coleção KeyValueConfigurationCollection.
CopyTo(ConfigurationElement[], Int32)	Copia o conteúdo do ConfigurationElementCollection para uma matriz. (Herdado de ConfigurationElementCollection)
CreateNewElement()	Quando substituído em uma classe derivada, o método CreateNewElement() cria um novo objeto KeyValueConfigurationElement.
CreateNewElement(String)	Cria um novo ConfigurationElement quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Lê o XML do arquivo de configuração. (Herdado de ConfigurationElement)
Equals(Object)	Compara o ConfigurationElementCollection ao objeto especificado. (Herdado de ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	Obtém a chave de elemento para um elemento de configuração especificado quando substituído em uma classe derivada.
GetEnumerator()	Obtém um IEnumerator que é usado para iterar por meio de ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
GetHashCode()	Obtém um valor exclusivo que representa a instância ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Retorna a versão transformada do nome do assembly especificado. (Herdado de ConfigurationElement)
GetTransformedTypeString(String)	Retorna a versão transformada do nome do tipo especificado. (Herdado de ConfigurationElement)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
Init()	Define o objeto ConfigurationElement para seu estado inicial. (Herdado de ConfigurationElement)
InitializeDefault()	Usado para inicializar um conjunto padrão de valores para o objeto ConfigurationElement. (Herdado de ConfigurationElement)
IsElementName(String)	Indica se o ConfigurationElement especificado existe no ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Indica se o ConfigurationElement especificado pode ser removido de ConfigurationElementCollection. (Herdado de ConfigurationElementCollection)
IsModified()	Indica se este ConfigurationElementCollection foi modificado desde a última vez em que foi salvo ou carregado quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
IsReadOnly()	Indica se o objeto ConfigurationElementCollection é somente leitura. (Herdado de ConfigurationElementCollection)
ListErrors(IList)	Adiciona os erros de propriedade inválida deste objeto ConfigurationElement e de todos os subelementos à lista passada. (Herdado de ConfigurationElement)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
OnDeserializeUnrecognizedAttribute(String, String)	Obtém um valor que indica se um atributo desconhecido é encontrado durante a desserialização. (Herdado de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Faz com que o sistema de configuração lance uma exceção. (Herdado de ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Gera uma exceção quando uma propriedade necessária não é encontrada. (Herdado de ConfigurationElement)
PostDeserialize()	Chamado depois da desserialização. (Herdado de ConfigurationElement)
PreSerialize(XmlWriter)	Chamado antes da serialização. (Herdado de ConfigurationElement)
Remove(String)	Remove um objeto KeyValueConfigurationElement da coleção.
Reset(ConfigurationElement)	Redefine o ConfigurationElementCollection para seu estado inalterado quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
ResetModified()	Redefine o valor da propriedade IsModified() para false quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Grava os dados de configuração em um elemento XML no arquivo de configuração quando substituído em uma classe derivada. (Herdado de ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Grava as marcas externas desse elemento de configuração no arquivo de configuração quando implementado em uma classe derivada. (Herdado de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Define uma propriedade para o valor especificado. (Herdado de ConfigurationElement)
SetReadOnly()	Define a propriedade IsReadOnly() para o objeto ConfigurationElementCollection e para todos os subelementos. (Herdado de ConfigurationElementCollection)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Inverte o efeito da mesclagem de informações de configuração de diferentes níveis da hierarquia de configuração. (Herdado de ConfigurationElementCollection)

Implantações explícitas de interface

ICollection.CopyTo(Array, Int32)

Copia o ConfigurationElementCollection para uma matriz. (Herdado de ConfigurationElementCollection)

Métodos de Extensão