KeyValueConfigurationCollection Класс

Определение

Пространство имен:

System.Configuration

Сборка:

System.Configuration.ConfigurationManager.dll

Пакет:

System.Configuration.ConfigurationManager v8.0.0

Исходный код:

KeyValueConfigurationCollection.cs

Содержит коллекцию объектов 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

Наследование

Object

ConfigurationElement

ConfigurationElementCollection

KeyValueConfigurationCollection

Атрибуты

ConfigurationCollectionAttribute

Примеры

В следующем примере кода показано, как использовать KeyValueConfigurationCollection тип .

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

Комментарии

Этот класс представляет коллекцию пар, где каждая пара состоит из строки, выступающей в качестве ключа коллекции, и строкового значения. Так как первый элемент является ключом, он должен быть уникальным для всей коллекции.

Конструкторы

KeyValueConfigurationCollection()

Инициализирует новый экземпляр класса KeyValueConfigurationCollection.

Свойства

AddElementName	Возвращает или устанавливает имя ConfigurationElement, связанное с операцией добавления в ConfigurationElementCollection после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
AllKeys	Возвращает ключи всех элементов в коллекции KeyValueConfigurationCollection.
ClearElementName	Возвращает или задает имя ConfigurationElement, связанное с операцией очистки в ConfigurationElementCollection после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
CollectionType	Возвращает тип службы ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
Count	Получает количество элементов коллекции. (Унаследовано от ConfigurationElementCollection)
CurrentConfiguration	Возвращает ссылку на экземпляр Configuration верхнего уровня, представляющий иерархию конфигурации, к которой относится текущий экземпляр ConfigurationElement. (Унаследовано от ConfigurationElement)
ElementInformation	Возвращает объект ElementInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
ElementName	Получает имя, используемое для данной коллекции элементов в файле конфигурации после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
ElementProperty	Возвращает объект ConfigurationElementProperty, представляющий сам объект ConfigurationElement. (Унаследовано от ConfigurationElement)
EmitClear	Получает или задает значение, указывающее, была ли коллекция очищена. (Унаследовано от ConfigurationElementCollection)
EvaluationContext	Возвращает объект ContextInformation для объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
HasContext	Возвращает значение, указывающее, имеет ли свойство CurrentConfiguration значение null. (Унаследовано от ConfigurationElement)
IsSynchronized	Возвращает значение, показывающее, синхронизирован ли доступ к коллекции. (Унаследовано от ConfigurationElementCollection)
Item[ConfigurationProperty]	Возвращает или задает свойство или атрибут данного элемента конфигурации. (Унаследовано от ConfigurationElement)
Item[String]	Возвращает объект KeyValueConfigurationElement, созданный на основе указанных параметров.
LockAllAttributesExcept	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockAllElementsExcept	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockAttributes	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockElements	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockItem	Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement)
Properties	Возвращает коллекцию свойств конфигурации.
RemoveElementName	Получает или задает имя ConfigurationElement, связанное с операцией удаления в ConfigurationElementCollection после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
SyncRoot	Получает объект, используемый для синхронизации доступа к ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
ThrowOnDuplicate	Возвращает значение, указывающее, выдаст ли исключение попытка добавить дубликат объекта KeyValueConfigurationElement в коллекцию KeyValueConfigurationCollection.

Методы

Add(KeyValueConfigurationElement)	Добавляет объект KeyValueConfigurationElement в коллекцию на основе указанных параметрах.
Add(String, String)	Добавляет объект KeyValueConfigurationElement в коллекцию на основе указанных параметрах.
BaseAdd(ConfigurationElement)	Добавляет новый элемент конфигурации в ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
BaseAdd(ConfigurationElement, Boolean)	Добавляет элемент конфигурации в коллекцию элементов конфигурации. (Унаследовано от ConfigurationElementCollection)
BaseAdd(Int32, ConfigurationElement)	Добавляет элемент конфигурации в коллекцию элементов конфигурации. (Унаследовано от ConfigurationElementCollection)
BaseClear()	Удаляет все объекты элементов конфигурации из коллекции. (Унаследовано от ConfigurationElementCollection)
BaseGet(Int32)	Возвращает элемент конфигурации с указанным расположением индекса. (Унаследовано от ConfigurationElementCollection)
BaseGet(Object)	Возвращает элемент конфигурации с указанным ключом. (Унаследовано от ConfigurationElementCollection)
BaseGetAllKeys()	Возвращает массив ключей для всех элементов конфигурации, содержащихся в ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
BaseGetKey(Int32)	Получает ключ объекта ConfigurationElement по указанному расположению индекса. (Унаследовано от ConfigurationElementCollection)
BaseIndexOf(ConfigurationElement)	Указывает индекс заданного объекта ConfigurationElement. (Унаследовано от ConfigurationElementCollection)
BaseIsRemoved(Object)	Указывает, удален ли ConfigurationElement с указанным ключом из ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
BaseRemove(Object)	Удаляет объект ConfigurationElement из коллекции. (Унаследовано от ConfigurationElementCollection)
BaseRemoveAt(Int32)	Удаляет объект ConfigurationElement по указанному расположению индекса. (Унаследовано от ConfigurationElementCollection)
Clear()	Очищает коллекцию KeyValueConfigurationCollection.
CopyTo(ConfigurationElement[], Int32)	Копирует содержимое объекта ConfigurationElementCollection в массив. (Унаследовано от ConfigurationElementCollection)
CreateNewElement()	При переопределении в производном классе метод CreateNewElement()создает новый объект KeyValueConfigurationElement.
CreateNewElement(String)	При переопределении в производном классе создает новый элемент ConfigurationElement. (Унаследовано от ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement)
Equals(Object)	Сравнивает ConfigurationElementCollection с указанным объектом. (Унаследовано от ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	При переопределении в производном классе возвращает ключ указанного элемента конфигурации.
GetEnumerator()	Получает метод IEnumerator, используемый для итерации по ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
GetHashCode()	Получает уникальное значение, представляющее экземпляр ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
GetTransformedAssemblyString(String)	Возвращает преобразованную версию указанного имени сборки. (Унаследовано от ConfigurationElement)
GetTransformedTypeString(String)	Возвращает преобразованную версию указанного имени типа. (Унаследовано от ConfigurationElement)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
Init()	Задает объект ConfigurationElement в исходное состояние. (Унаследовано от ConfigurationElement)
InitializeDefault()	Используется для инициализации набора значений по умолчанию для объекта ConfigurationElement. (Унаследовано от ConfigurationElement)
IsElementName(String)	Указывает, существует ли указанный ConfigurationElement в ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
IsElementRemovable(ConfigurationElement)	Указывает, может ли указанный объект ConfigurationElement быть удален из ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
IsModified()	Указывает, был ли изменен ConfigurationElementCollection с момента последнего сохранения или загрузки после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
IsReadOnly()	Указывает, доступен ли объект ConfigurationElementCollection только для чтения. (Унаследовано от ConfigurationElementCollection)
ListErrors(IList)	Добавляет ошибку "недействительное свойство" в данном объекте ConfigurationElement и всех его дочерних элементах к переданному списку. (Унаследовано от ConfigurationElement)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
OnDeserializeUnrecognizedAttribute(String, String)	Возвращает значение, указывающее, встретился ли неизвестный атрибут при десериализации. (Унаследовано от ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)	Приводит к тому, что система конфигурации выдает исключение. (Унаследовано от ConfigurationElementCollection)
OnRequiredPropertyNotFound(String)	Выдает исключение, если требуемое свойство не найдено. (Унаследовано от ConfigurationElement)
PostDeserialize()	Вызывается после десериализации. (Унаследовано от ConfigurationElement)
PreSerialize(XmlWriter)	Вызывается до сериализации. (Унаследовано от ConfigurationElement)
Remove(String)	Удаляет объект KeyValueConfigurationElement из коллекции.
Reset(ConfigurationElement)	Сбрасывает ConfigurationElementCollection в неизмененное состояние после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
ResetModified()	Переустанавливает значение свойства IsModified() в false при переопределении в производном классе. (Унаследовано от ConfigurationElementCollection)
SerializeElement(XmlWriter, Boolean)	Записывает данные конфигурации в XML-элемент в файле конфигурации после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
SerializeToXmlElement(XmlWriter, String)	Записывает внешние теги данного элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	Задает для свойства указанное значение. (Унаследовано от ConfigurationElement)
SetReadOnly()	Устанавливает свойство IsReadOnly() для объекта ConfigurationElementCollection и всех подчиненных элементов. (Унаследовано от ConfigurationElementCollection)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	Отменяет эффект слияния данных конфигурации на разных уровнях иерархии конфигурации. (Унаследовано от ConfigurationElementCollection)

Явные реализации интерфейса

ICollection.CopyTo(Array, Int32)

Копирует ConfigurationElementCollection в массив. (Унаследовано от ConfigurationElementCollection)

Методы расширения