NameValueConfigurationCollection Класс

Определение

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

System.Configuration

Сборка:

System.Configuration.ConfigurationManager.dll

Пакет:

System.Configuration.ConfigurationManager v8.0.0

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

NameValueConfigurationCollection.cs

Содержит коллекцию объектов NameValueConfigurationElement. Этот класс не наследуется.

public ref class NameValueConfigurationCollection sealed : System::Configuration::ConfigurationElementCollection

[System.Configuration.ConfigurationCollection(typeof(System.Configuration.NameValueConfigurationElement))]
public sealed class NameValueConfigurationCollection : System.Configuration.ConfigurationElementCollection

[<System.Configuration.ConfigurationCollection(typeof(System.Configuration.NameValueConfigurationElement))>]
type NameValueConfigurationCollection = class
    inherit ConfigurationElementCollection

Public NotInheritable Class NameValueConfigurationCollection
Inherits ConfigurationElementCollection

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

Object

ConfigurationElement

ConfigurationElementCollection

NameValueConfigurationCollection

Атрибуты

ConfigurationCollectionAttribute

Примеры

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

#region Using directives

using System;
using System.Configuration;
using System.Web.Configuration;
using System.Collections;
using System.Text;

#endregion

namespace Samples.AspNet
{
    class UsingNameValueConfigurationCollection
    {
        static void Main(string[] args)
        {
            try
            {
                // Set the path of the config file.
                // Make sure that you have a Web site on the
                // same server called TestConfig.
                string configPath = "/TestConfig";

                // Get the Web application configuration object.
                Configuration config =
                  WebConfigurationManager.OpenWebConfiguration(configPath);

                // Get the section related object.
                AnonymousIdentificationSection configSection =
                  (AnonymousIdentificationSection)config.GetSection
                  ("system.web/anonymousIdentification");

                // Display title and info.
                Console.WriteLine("Configuration Info");
                Console.WriteLine();

                // Display Config details.
                Console.WriteLine("File Path: {0}",
                  config.FilePath);
                Console.WriteLine("Section Path: {0}",
                  configSection.SectionInformation.Name);
                Console.WriteLine();

                // Create a NameValueConfigurationCollection object.
                NameValueConfigurationCollection myNameValConfigCollection =
                  new NameValueConfigurationCollection();

                foreach (PropertyInformation propertyItem in
                  configSection.ElementInformation.Properties)
                {
                    // Assign  domain name.
                    if (propertyItem.Name == "domain")
                        propertyItem.Value = "MyDomain";

                    if (propertyItem.Value != null)
                    {
                        // Enable SSL for cookie exchange.
                        if (propertyItem.Name == "cookieRequireSSL")
                            propertyItem.Value = true;

                        NameValueConfigurationElement nameValConfigElement =
                            new NameValueConfigurationElement
                                (propertyItem.Name.ToString(), propertyItem.Value.ToString());

                        // Add a NameValueConfigurationElement
                        // to the collection.
                        myNameValConfigCollection.Add(nameValConfigElement);
                    }
                }

                // Count property.
                Console.WriteLine("Collection Count: {0}",
                 myNameValConfigCollection.Count);

                // Item property.
                Console.WriteLine("Value of property 'enabled': {0}",
                 myNameValConfigCollection["enabled"].Value);

                // Display the contents of the collection.
                foreach (NameValueConfigurationElement configItem
                  in myNameValConfigCollection)
                {
                    Console.WriteLine();
                    Console.WriteLine("Configuration Details:");
                    Console.WriteLine("Name: {0}", configItem.Name);
                    Console.WriteLine("Value: {0}", configItem.Value);
                }

                // Assign the domain calue.
                configSection.Domain = myNameValConfigCollection["domain"].Value;
                // Assign the SSL required value.
                if (myNameValConfigCollection["cookieRequireSSL"].Value == "true")
                    configSection.CookieRequireSSL = true;

                // Remove domain from the collection.
                NameValueConfigurationElement myConfigElement =
                    myNameValConfigCollection["domain"];
                // Remove method.
                myNameValConfigCollection.Remove(myConfigElement);

                // Save changes to the configuration file.
                // This modifies the Web.config of the TestConfig site.
                config.Save(ConfigurationSaveMode.Minimal, true);

                // Clear the collection.
                myNameValConfigCollection.Clear();
            }

            catch (Exception e)
            {
                // Unknown error.
                Console.WriteLine(e.ToString());
            }

            // Display and wait.
            Console.ReadLine();
        }
    }
}

Imports System.Configuration
Imports System.Web
Imports System.Collections
Imports System.Text


Namespace Samples.AspNet
    Class UsingNameValueConfigurationCollection
        Public Shared Sub Main(ByVal args As String())
            Try
                ' Set the path of the config file. 
                ' Make sure that you have a Web site on the
                ' same server called TestConfig.
                Dim configPath As String = "/TestConfig"

                ' Get the Web application configuration object.
                Dim config As Configuration = _
                System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

                ' Get the section related object.
                Dim configSection _
                As System.Web.Configuration.AnonymousIdentificationSection = _
                DirectCast(config.GetSection("system.web/anonymousIdentification"),  _
                System.Web.Configuration.AnonymousIdentificationSection)

                ' Display title and info.
                Console.WriteLine("Configuration Info")
                Console.WriteLine()

                ' Display Config details.
                Console.WriteLine("File Path: {0}", config.FilePath)
                Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)
                Console.WriteLine()

                ' Create a NameValueConfigurationCollection object.
                Dim myNameValConfigCollection As New NameValueConfigurationCollection()

                For Each propertyItem As PropertyInformation In configSection.ElementInformation.Properties
                    ' Assign  domain name.
                    If propertyItem.Name = "domain" Then
                        propertyItem.Value = "MyDomain"
                    End If

                    If propertyItem.Value <> Nothing Then
                        ' Enable SSL for cookie exchange.
                        If propertyItem.Name = "cookieRequireSSL" Then
                            propertyItem.Value = True
                        End If

                        Dim nameValConfigElement As New NameValueConfigurationElement(propertyItem.Name.ToString(), propertyItem.Value.ToString())

                        ' Add a NameValueConfigurationElement
                        ' to the collection.

                        myNameValConfigCollection.Add(nameValConfigElement)
                    End If
                Next

                ' Count property.
                Console.WriteLine("Collection Count: {0}", myNameValConfigCollection.Count)

                ' Item property.
                Console.WriteLine("Value of property 'enabled': {0}", myNameValConfigCollection("enabled").Value)

                ' Display the contents of the collection.
                For Each configItem As NameValueConfigurationElement In myNameValConfigCollection
                    Console.WriteLine()
                    Console.WriteLine("Configuration Details:")
                    Console.WriteLine("Name: {0}", configItem.Name)
                    Console.WriteLine("Value: {0}", configItem.Value)
                Next

                ' Assign the domain calue.
                configSection.Domain = myNameValConfigCollection("domain").Value
                ' Assign the SSL required value.
                If myNameValConfigCollection("cookieRequireSSL").Value = "true" Then
                    configSection.CookieRequireSSL = True
                End If

                ' Remove domain from the collection.
                Dim myConfigElement As NameValueConfigurationElement = myNameValConfigCollection("domain")
                ' Remove method.
                myNameValConfigCollection.Remove(myConfigElement)

                ' Save changes to the configuration file.
                ' This modifies the Web.config of the TestConfig site.
                config.Save(ConfigurationSaveMode.Minimal, True)

                ' Clear the collection.
                myNameValConfigCollection.Clear()
            Catch e As Exception

                ' Unknown error.
                Console.WriteLine(e.ToString())
            End Try

            ' Display and wait.
            Console.ReadLine()
        End Sub
    End Class
End Namespace

Комментарии

Класс NameValueConfigurationCollection позволяет программно получить доступ к коллекции NameValueConfigurationElement объектов .

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

NameValueConfigurationCollection()

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

Свойства

AddElementName	Возвращает или устанавливает имя ConfigurationElement, связанное с операцией добавления в ConfigurationElementCollection после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
AllKeys	Возвращает ключи всех элементов, содержащихся в NameValueConfigurationCollection.
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]	Возвращает или задает объект NameValueConfigurationElement, созданный на основе указанных параметров.
LockAllAttributesExcept	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockAllElementsExcept	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockAttributes	Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement)
LockElements	Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement)
LockItem	Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement)
Properties	Возвращает коллекцию свойств. (Унаследовано от ConfigurationElement)
RemoveElementName	Получает или задает имя ConfigurationElement, связанное с операцией удаления в ConfigurationElementCollection после переопределения в производном классе. (Унаследовано от ConfigurationElementCollection)
SyncRoot	Получает объект, используемый для синхронизации доступа к ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)
ThrowOnDuplicate	Возвращает значение, указывающее, выдаст ли исключение попытка добавить дубликат ConfigurationElement к ConfigurationElementCollection. (Унаследовано от ConfigurationElementCollection)

Методы

Add(NameValueConfigurationElement)	Добавляет объект NameValueConfigurationElement в коллекцию.
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()	Очищает NameValueConfigurationCollection.
CopyTo(ConfigurationElement[], Int32)	Копирует содержимое объекта ConfigurationElementCollection в массив. (Унаследовано от ConfigurationElementCollection)
CreateNewElement()	При переопределении в производном классе создает новый объект ConfigurationElement. (Унаследовано от ConfigurationElementCollection)
CreateNewElement(String)	При переопределении в производном классе создает новый элемент ConfigurationElement. (Унаследовано от ConfigurationElementCollection)
DeserializeElement(XmlReader, Boolean)	Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement)
Equals(Object)	Сравнивает ConfigurationElementCollection с указанным объектом. (Унаследовано от ConfigurationElementCollection)
GetElementKey(ConfigurationElement)	При переопределении в производном классе возвращает ключ указанного элемента конфигурации. (Унаследовано от ConfigurationElementCollection)
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(NameValueConfigurationElement)	Удаляет объект NameValueConfigurationElement из коллекции, основанной на предоставленном параметре.
Remove(String)	Удаляет объект NameValueConfigurationElement из коллекции, основанной на предоставленном параметре.
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)

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

См. также раздел

• NameValueConfigurationElement