KeyValueConfigurationElement Classe

Definição

Namespace:

System.Configuration

Assembly:

System.Configuration.ConfigurationManager.dll

Pacote:

System.Configuration.ConfigurationManager v8.0.0

Origem:

KeyValueConfigurationElement.cs

Representa um elemento de configuração que contém um par chave/valor.

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

public class KeyValueConfigurationElement : System.Configuration.ConfigurationElement

type KeyValueConfigurationElement = class
    inherit ConfigurationElement

Public Class KeyValueConfigurationElement
Inherits ConfigurationElement

Herança

Object

ConfigurationElement

KeyValueConfigurationElement

Exemplos

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

Comentários

O KeyValueConfigurationElement objeto herda da ConfigurationElement classe base. O ConfigurationElement objeto representa um elemento dentro de um arquivo de configuração. O KeyValueConfigurationElement objeto pode pertencer a uma KeyValueConfigurationCollection coleção.

Construtores

KeyValueConfigurationElement(String, String)

Inicializa uma nova instância da classe KeyValueConfigurationElement com base nos parâmetros fornecidos.

Propriedades

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)
ElementProperty	Obtém o objeto ConfigurationElementProperty que representa o próprio objeto ConfigurationElement. (Herdado de ConfigurationElement)
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)
Item[ConfigurationProperty]	Obtém ou define uma propriedade ou um atributo desse elemento de configuração. (Herdado de ConfigurationElement)
Item[String]	Obtém ou define uma propriedade, atributo ou elemento filho desse elemento de configuração. (Herdado de ConfigurationElement)
Key	Obtém a chave do objeto KeyValueConfigurationElement.
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 a coleção de propriedades.
Value	Obtém ou define o valor do objeto KeyValueConfigurationElement.

Métodos

DeserializeElement(XmlReader, Boolean)	Lê o XML do arquivo de configuração. (Herdado de ConfigurationElement)
Equals(Object)	Compara a instância ConfigurationElement atual com o objeto especificado. (Herdado de ConfigurationElement)
GetHashCode()	Obtém um valor exclusivo que representa a instância ConfigurationElement atual. (Herdado de ConfigurationElement)
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 KeyValueConfigurationElement para seu estado inicial.
InitializeDefault()	Usado para inicializar um conjunto padrão de valores para o objeto ConfigurationElement. (Herdado de ConfigurationElement)
IsModified()	Indica se este elemento de configuração foi modificado desde a última vez em que foi salvo ou carregado quando implementado em uma classe derivada. (Herdado de ConfigurationElement)
IsReadOnly()	Obtém um valor que indica se o objeto ConfigurationElement é somente leitura. (Herdado de ConfigurationElement)
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)	Obtém um valor que indica se um elemento desconhecido é encontrado durante a desserialização. (Herdado de ConfigurationElement)
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)
Reset(ConfigurationElement)	Redefine o estado interno do objeto ConfigurationElement, incluindo os bloqueios e as coleções de propriedades. (Herdado de ConfigurationElement)
ResetModified()	Redefine o valor do método IsModified() para false quando implementado em uma classe derivada. (Herdado de ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	Grava o conteúdo desse elemento de configuração no arquivo de configuração quando implementado em uma classe derivada. (Herdado de ConfigurationElement)
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 ConfigurationElement e para todos os subelementos. (Herdado de ConfigurationElement)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Modifica o objeto ConfigurationElement para remover todos os valores que não devem ser salvos. (Herdado de ConfigurationElement)

Confira também

• ConfigurationElement