KeyValueConfigurationElement Clase
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Representa un elemento de configuración que contiene un par clave-valor.
public ref class KeyValueConfigurationElement : System::Configuration::ConfigurationElement
public class KeyValueConfigurationElement : System.Configuration.ConfigurationElement
type KeyValueConfigurationElement = class
inherit ConfigurationElement
Public Class KeyValueConfigurationElement
Inherits ConfigurationElement
- Herencia
Ejemplos
En el ejemplo de código siguiente se muestra cómo usar miembros de la KeyValueConfigurationElement clase .
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
El KeyValueConfigurationElement objeto hereda de la ConfigurationElement clase base. El ConfigurationElement objeto representa un elemento dentro de un archivo de configuración. El KeyValueConfigurationElement objeto puede pertenecer a una KeyValueConfigurationCollection colección.
Constructores
| Nombre | Description |
|---|---|
| KeyValueConfigurationElement(String, String) |
Inicializa una nueva instancia de la KeyValueConfigurationElement clase basándose en los parámetros proporcionados. |
Propiedades
| Nombre | Description |
|---|---|
| CurrentConfiguration |
Obtiene una referencia a la instancia de nivel Configuration superior que representa la jerarquía de configuración a la que pertenece la instancia actual ConfigurationElement . (Heredado de ConfigurationElement) |
| ElementInformation |
Obtiene un ElementInformation objeto que contiene la información y la funcionalidad no personalizables del ConfigurationElement objeto . (Heredado de ConfigurationElement) |
| ElementProperty |
Obtiene el ConfigurationElementProperty objeto que representa el ConfigurationElement propio objeto. (Heredado de ConfigurationElement) |
| EvaluationContext |
Obtiene el objeto ContextInformation para el objeto ConfigurationElement. (Heredado de ConfigurationElement) |
| HasContext |
Obtiene un valor que indica si la CurrentConfiguration propiedad es |
| Item[ConfigurationProperty] |
Obtiene o establece una propiedad o atributo de este elemento de configuración. (Heredado de ConfigurationElement) |
| Item[String] |
Obtiene o establece una propiedad, un atributo o un elemento secundario de este elemento de configuración. (Heredado de ConfigurationElement) |
| Key |
Obtiene la clave del KeyValueConfigurationElement objeto . |
| 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 la colección de propiedades. |
| Value |
Obtiene o establece el valor del KeyValueConfigurationElement objeto . |
Métodos
| Nombre | Description |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Lee XML del archivo de configuración. (Heredado de ConfigurationElement) |
| Equals(Object) |
Compara la instancia actual ConfigurationElement con el objeto especificado. (Heredado de ConfigurationElement) |
| GetHashCode() |
Obtiene un valor único que representa la instancia actual ConfigurationElement . (Heredado de ConfigurationElement) |
| 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 KeyValueConfigurationElement objeto en su estado inicial. |
| InitializeDefault() |
Se usa para inicializar un conjunto predeterminado de valores para el ConfigurationElement objeto . (Heredado de ConfigurationElement) |
| IsModified() |
Indica si este elemento de configuración se ha modificado desde que se guardó o cargó por última vez, cuando se implementó en una clase derivada. (Heredado de ConfigurationElement) |
| IsReadOnly() |
Obtiene un valor que indica si el ConfigurationElement objeto es de solo lectura. (Heredado de ConfigurationElement) |
| ListErrors(IList) |
Agrega los errores de propiedad no válida en este ConfigurationElement objeto y, en todos los subelementos, a la lista pasada. (Heredado de ConfigurationElement) |
| MemberwiseClone() |
Crea una copia superficial del Objectactual. (Heredado de Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Obtiene un valor que indica si se encuentra un atributo desconocido durante la deserialización. (Heredado de ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Obtiene un valor que indica si se encuentra un elemento desconocido durante la deserialización. (Heredado de ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Produce una excepción cuando no se encuentra una propiedad necesaria. (Heredado de ConfigurationElement) |
| PostDeserialize() |
Se llama después de la deserialización. (Heredado de ConfigurationElement) |
| PreSerialize(XmlWriter) |
Se llama antes de la serialización. (Heredado de ConfigurationElement) |
| Reset(ConfigurationElement) |
Restablece el estado interno del ConfigurationElement objeto, incluidos los bloqueos y las colecciones de propiedades. (Heredado de ConfigurationElement) |
| ResetModified() |
Restablece el valor del IsModified() método a |
| SerializeElement(XmlWriter, Boolean) |
Escribe el contenido de este elemento de configuración en el archivo de configuración cuando se implementa en una clase derivada. (Heredado de ConfigurationElement) |
| 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 IsReadOnly() propiedad para el ConfigurationElement objeto y todos los subelementos. (Heredado de ConfigurationElement) |
| ToString() |
Devuelve una cadena que representa el objeto actual. (Heredado de Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modifica el ConfigurationElement objeto para quitar todos los valores que no se deben guardar. (Heredado de ConfigurationElement) |