KeyValueConfigurationElement Classe

Definição

Representa um elemento de configuração que contém um par chave/valor.Represents a configuration element that contains a key/value pair.

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
KeyValueConfigurationElement

Exemplos

O exemplo de código a seguir demonstra como usar membros da classe KeyValueConfigurationElement.The following code example demonstrates how to use members of the KeyValueConfigurationElement class.

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 objeto KeyValueConfigurationElement herda da classe base ConfigurationElement.The KeyValueConfigurationElement object inherits from the ConfigurationElement base class. O objeto ConfigurationElement representa um elemento dentro de um arquivo de configuração.The ConfigurationElement object represents an element within a configuration file. O objeto KeyValueConfigurationElement pode pertencer a uma coleção de KeyValueConfigurationCollection.The KeyValueConfigurationElement object can belong in a KeyValueConfigurationCollection collection.

Construtores

KeyValueConfigurationElement(String, String)

Inicializa uma nova instância da classe KeyValueConfigurationElement com base nos parâmetros fornecidos.Initializes a new instance of the KeyValueConfigurationElement class based on the supplied parameters.

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.Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(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.Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Herdado de ConfigurationElement)
ElementProperty

Obtém o objeto ConfigurationElementProperty que representa o próprio objeto ConfigurationElement.Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Herdado de ConfigurationElement)
EvaluationContext

Obtém o objeto ContextInformation para o objeto ConfigurationElement.Gets the ContextInformation object for the ConfigurationElement object.

(Herdado de ConfigurationElement)
HasContext

Obtém um valor que indica se a propriedade CurrentConfiguration é null.Gets a value that indicates whether the CurrentConfiguration property is null.

(Herdado de ConfigurationElement)
Item[ConfigurationProperty]

Obtém ou define uma propriedade ou um atributo desse elemento de configuração.Gets or sets a property or attribute of this configuration element.

(Herdado de ConfigurationElement)
Item[String]

Obtém ou define uma propriedade, atributo ou elemento filho desse elemento de configuração.Gets or sets a property, attribute, or child element of this configuration element.

(Herdado de ConfigurationElement)
Key

Obtém a chave do objeto KeyValueConfigurationElement.Gets the key of the KeyValueConfigurationElement object.

LockAllAttributesExcept

Obtém a coleção de atributos bloqueados.Gets the collection of locked attributes.

(Herdado de ConfigurationElement)
LockAllElementsExcept

Obtém a coleção de elementos bloqueados.Gets the collection of locked elements.

(Herdado de ConfigurationElement)
LockAttributes

Obtém a coleção de atributos bloqueados.Gets the collection of locked attributes.

(Herdado de ConfigurationElement)
LockElements

Obtém a coleção de elementos bloqueados.Gets the collection of locked elements.

(Herdado de ConfigurationElement)
LockItem

Obtém ou define um valor que indica se o elemento está bloqueado.Gets or sets a value indicating whether the element is locked.

(Herdado de ConfigurationElement)
Properties

Obtém a coleção de propriedades.Gets the collection of properties.

Value

Obtém ou define o valor do objeto KeyValueConfigurationElement.Gets or sets the value of the KeyValueConfigurationElement object.

Métodos

DeserializeElement(XmlReader, Boolean)

Lê o XML do arquivo de configuração.Reads XML from the configuration file.

(Herdado de ConfigurationElement)
Equals(Object)

Compara a instância ConfigurationElement atual com o objeto especificado.Compares the current ConfigurationElement instance to the specified object.

(Herdado de ConfigurationElement)
GetHashCode()

Obtém um valor exclusivo que representa a instância ConfigurationElement atual.Gets a unique value representing the current ConfigurationElement instance.

(Herdado de ConfigurationElement)
GetTransformedAssemblyString(String)

Retorna a versão transformada do nome do assembly especificado.Returns the transformed version of the specified assembly name.

(Herdado de ConfigurationElement)
GetTransformedTypeString(String)

Retorna a versão transformada do nome do tipo especificado.Returns the transformed version of the specified type name.

(Herdado de ConfigurationElement)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
Init()

Define o objeto KeyValueConfigurationElement para seu estado inicial.Sets the KeyValueConfigurationElement object to its initial state.

InitializeDefault()

Usado para inicializar um conjunto padrão de valores para o objeto ConfigurationElement.Used to initialize a default set of values for the ConfigurationElement object.

(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.Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.

(Herdado de ConfigurationElement)
IsReadOnly()

Obtém um valor que indica se o objeto ConfigurationElement é somente leitura.Gets a value indicating whether the ConfigurationElement object is read-only.

(Herdado de ConfigurationElement)
ListErrors(IList)

Adiciona os erros de propriedade inválida deste objeto ConfigurationElement e de todos os subelementos à lista passada.Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Herdado de ConfigurationElement)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
OnDeserializeUnrecognizedAttribute(String, String)

Obtém um valor que indica se um atributo desconhecido é encontrado durante a desserialização.Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Herdado de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Obtém um valor que indica se um elemento desconhecido é encontrado durante a desserialização.Gets a value indicating whether an unknown element is encountered during deserialization.

(Herdado de ConfigurationElement)
OnRequiredPropertyNotFound(String)

Gera uma exceção quando uma propriedade necessária não é encontrada.Throws an exception when a required property is not found.

(Herdado de ConfigurationElement)
PostDeserialize()

Chamado depois da desserialização.Called after deserialization.

(Herdado de ConfigurationElement)
PreSerialize(XmlWriter)

Chamado antes da serialização.Called before serialization.

(Herdado de ConfigurationElement)
Reset(ConfigurationElement)

Redefine o estado interno do objeto ConfigurationElement, incluindo os bloqueios e as coleções de propriedades.Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Herdado de ConfigurationElement)
ResetModified()

Redefine o valor do método IsModified() para false quando implementado em uma classe derivada.Resets the value of the IsModified() method to false when implemented in a derived class.

(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.Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(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.Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Herdado de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Define uma propriedade para o valor especificado.Sets a property to the specified value.

(Herdado de ConfigurationElement)
SetReadOnly()

Define a propriedade IsReadOnly() para o objeto ConfigurationElement e para todos os subelementos.Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Herdado de ConfigurationElement)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifica o objeto ConfigurationElement para remover todos os valores que não devem ser salvos.Modifies the ConfigurationElement object to remove all values that should not be saved.

(Herdado de ConfigurationElement)

Aplica-se a

Veja também