KeyValueConfigurationElement Klasa

Definicja

Reprezentuje element konfiguracji, który zawiera parę klucz/wartość.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
Dziedziczenie
KeyValueConfigurationElement

Przykłady

Poniższy przykład kodu demonstruje, jak używać elementów członkowskich KeyValueConfigurationElement klasy.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

Uwagi

KeyValueConfigurationElementObiekt dziedziczy z ConfigurationElement klasy bazowej.The KeyValueConfigurationElement object inherits from the ConfigurationElement base class. ConfigurationElementObiekt reprezentuje element w pliku konfiguracji.The ConfigurationElement object represents an element within a configuration file. KeyValueConfigurationElementObiekt może należeć do KeyValueConfigurationCollection kolekcji.The KeyValueConfigurationElement object can belong in a KeyValueConfigurationCollection collection.

Konstruktory

KeyValueConfigurationElement(String, String)

Inicjuje nowe wystąpienie KeyValueConfigurationElement klasy na podstawie podanych parametrów.Initializes a new instance of the KeyValueConfigurationElement class based on the supplied parameters.

Właściwości

CurrentConfiguration

Pobiera odwołanie do wystąpienia najwyższego poziomu Configuration , które reprezentuje hierarchię konfiguracji, do której ConfigurationElement należy bieżące wystąpienie.Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Odziedziczone po ConfigurationElement)
ElementInformation

Pobiera ElementInformation obiekt, który zawiera informacje, które nie są dostosowywane i funkcje ConfigurationElement obiektu.Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Odziedziczone po ConfigurationElement)
ElementProperty

Pobiera ConfigurationElementProperty obiekt, który reprezentuje ConfigurationElement sam obiekt.Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Odziedziczone po ConfigurationElement)
EvaluationContext

Pobiera ContextInformation obiekt dla ConfigurationElement obiektu.Gets the ContextInformation object for the ConfigurationElement object.

(Odziedziczone po ConfigurationElement)
HasContext

Pobiera wartość wskazującą, czy CurrentConfiguration Właściwość jest null .Gets a value that indicates whether the CurrentConfiguration property is null.

(Odziedziczone po ConfigurationElement)
Item[ConfigurationProperty]

Pobiera lub ustawia właściwość lub atrybut tego elementu konfiguracji.Gets or sets a property or attribute of this configuration element.

(Odziedziczone po ConfigurationElement)
Item[String]

Pobiera lub ustawia właściwość, atrybut lub element podrzędny tego elementu konfiguracji.Gets or sets a property, attribute, or child element of this configuration element.

(Odziedziczone po ConfigurationElement)
Key

Pobiera klucz KeyValueConfigurationElement obiektu.Gets the key of the KeyValueConfigurationElement object.

LockAllAttributesExcept

Pobiera kolekcję zablokowanych atrybutów.Gets the collection of locked attributes.

(Odziedziczone po ConfigurationElement)
LockAllElementsExcept

Pobiera kolekcję zablokowanych elementów.Gets the collection of locked elements.

(Odziedziczone po ConfigurationElement)
LockAttributes

Pobiera kolekcję zablokowanych atrybutów.Gets the collection of locked attributes.

(Odziedziczone po ConfigurationElement)
LockElements

Pobiera kolekcję zablokowanych elementów.Gets the collection of locked elements.

(Odziedziczone po ConfigurationElement)
LockItem

Pobiera lub ustawia wartość wskazującą, czy element jest zablokowany.Gets or sets a value indicating whether the element is locked.

(Odziedziczone po ConfigurationElement)
Properties

Pobiera kolekcję właściwości.Gets the collection of properties.

Value

Pobiera lub ustawia wartość KeyValueConfigurationElement obiektu.Gets or sets the value of the KeyValueConfigurationElement object.

Metody

DeserializeElement(XmlReader, Boolean)

Odczytuje dane XML z pliku konfiguracyjnego.Reads XML from the configuration file.

(Odziedziczone po ConfigurationElement)
Equals(Object)

Porównuje bieżące ConfigurationElement wystąpienie do określonego obiektu.Compares the current ConfigurationElement instance to the specified object.

(Odziedziczone po ConfigurationElement)
GetHashCode()

Pobiera unikatową wartość reprezentującą bieżące ConfigurationElement wystąpienie.Gets a unique value representing the current ConfigurationElement instance.

(Odziedziczone po ConfigurationElement)
GetTransformedAssemblyString(String)

Zwraca przekształconą wersję określonej nazwy zestawu.Returns the transformed version of the specified assembly name.

(Odziedziczone po ConfigurationElement)
GetTransformedTypeString(String)

Zwraca przekształconą wersję określonej nazwy typu.Returns the transformed version of the specified type name.

(Odziedziczone po ConfigurationElement)
GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
Init()

Ustawia KeyValueConfigurationElement obiekt do stanu początkowego.Sets the KeyValueConfigurationElement object to its initial state.

InitializeDefault()

Służy do inicjowania domyślnego zestawu wartości dla ConfigurationElement obiektu.Used to initialize a default set of values for the ConfigurationElement object.

(Odziedziczone po ConfigurationElement)
IsModified()

Wskazuje, czy ten element konfiguracji został zmodyfikowany od czasu ostatniego zapisania lub załadowania, gdy jest zaimplementowany w klasie pochodnej.Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.

(Odziedziczone po ConfigurationElement)
IsReadOnly()

Pobiera wartość wskazującą, czy ConfigurationElement obiekt jest tylko do odczytu.Gets a value indicating whether the ConfigurationElement object is read-only.

(Odziedziczone po ConfigurationElement)
ListErrors(IList)

Dodaje błędy nieprawidłowej właściwości w tym ConfigurationElement obiekcie i we wszystkich podelementach do listy zakończonych.Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Odziedziczone po ConfigurationElement)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
OnDeserializeUnrecognizedAttribute(String, String)

Pobiera wartość wskazującą, czy podczas deserializacji napotkano nieznany atrybut.Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Odziedziczone po ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Pobiera wartość wskazującą, czy nieznany element został napotkany podczas deserializacji.Gets a value indicating whether an unknown element is encountered during deserialization.

(Odziedziczone po ConfigurationElement)
OnRequiredPropertyNotFound(String)

Zgłasza wyjątek, gdy wymagana właściwość nie zostanie znaleziona.Throws an exception when a required property is not found.

(Odziedziczone po ConfigurationElement)
PostDeserialize()

Wywoływana po deserializacji.Called after deserialization.

(Odziedziczone po ConfigurationElement)
PreSerialize(XmlWriter)

Wywoływana przed serializacji.Called before serialization.

(Odziedziczone po ConfigurationElement)
Reset(ConfigurationElement)

Resetuje stan wewnętrzny ConfigurationElement obiektu, w tym blokady i kolekcje właściwości.Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Odziedziczone po ConfigurationElement)
ResetModified()

Resetuje wartość IsModified() metody do false po zaimplementowaniu w klasie pochodnej.Resets the value of the IsModified() method to false when implemented in a derived class.

(Odziedziczone po ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

Zapisuje zawartość tego elementu konfiguracji w pliku konfiguracji w przypadku zaimplementowania w klasie pochodnej.Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Odziedziczone po ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)

Zapisuje zewnętrzne Tagi tego elementu konfiguracji w pliku konfiguracji po zaimplementowaniu w klasie pochodnej.Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Odziedziczone po ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Ustawia właściwość na określoną wartość.Sets a property to the specified value.

(Odziedziczone po ConfigurationElement)
SetReadOnly()

Ustawia IsReadOnly() Właściwość dla ConfigurationElement obiektu i wszystkie podelementy.Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Odziedziczone po ConfigurationElement)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modyfikuje ConfigurationElement obiekt, aby usunąć wszystkie wartości, które nie powinny być zapisane.Modifies the ConfigurationElement object to remove all values that should not be saved.

(Odziedziczone po ConfigurationElement)

Dotyczy

Zobacz też