ConfigurationBuilder Класс

Определение

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

System.Configuration

Сборка:

System.Configuration.dll

Представляет базовый класс для расширения пользовательскими реализациями построителя конфигураций.

public ref class ConfigurationBuilder abstract : System::Configuration::Provider::ProviderBase

public abstract class ConfigurationBuilder : System.Configuration.Provider.ProviderBase

type ConfigurationBuilder = class
    inherit ProviderBase

Public MustInherit Class ConfigurationBuilder
Inherits ProviderBase

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

Object

ProviderBase

ConfigurationBuilder

Примеры

В следующем примере показано, как реализовать простой ConfigurationBuilder для чтения переменных среды:

using System;
using System.Configuration;
using System.Xml;

namespace Samples.AspNet.Config
{

   public class SampleConfigurationBuilder : ConfigurationBuilder
    {

        public override XmlNode ProcessRawXml(XmlNode rawXml) 
        {

            string rawXmlString = rawXml.OuterXml;

            if (String.IsNullOrEmpty(rawXmlString)) {
                return rawXml;
            }

            rawXmlString = Environment.ExpandEnvironmentVariables(rawXmlString);

            XmlDocument doc = new XmlDocument();
            doc.PreserveWhitespace = true;
            doc.LoadXml(rawXmlString);
            return doc.DocumentElement;
        }

        public override ConfigurationSection ProcessConfigurationSection(ConfigurationSection configSection) 
            => configSection;
    }
}

Imports System.Configuration
Imports System.Xml

Public Class SampleConfigurationBuilder : Inherits ConfigurationBuilder

    Public Overrides Function ProcessRawXml(rawXml As XmlNode)  As XmlNode

        Dim rawXmlString As String = rawXml.OuterXml

        If String.IsNullOrEmpty(rawXmlString) Then
            Return rawXml
        End If

        rawXmlString = Environment.ExpandEnvironmentVariables(rawXmlString)

        Dim doc As New XmlDocument()
        doc.PreserveWhitespace = True
        doc.LoadXml(rawXmlString)
        Return doc.DocumentElement
    End Function

    Public Overrides Function ProcessConfigurationSection(configSection As ConfigurationSection)  As ConfigurationSection
       Return configSection
    End Function

End Class

В следующем примере представлен фрагмент файла конфигурации, который применяется к предыдущему примеру. Это применяет переменные среды к конфигурации appSettings и делает эти значения доступными в ConfigurationManager.AppSettingsразделе .

<!-- To declare and use Configuration Builders in your configuration chain, update your app.config or web.config file as follows:  -->

<configSections>
  <section name="configBuilders" type="System.Configuration.ConfigurationBuildersSection, System.Configuration, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" restartOnExternalChanges="false" requirePermission="false"/>
</configSections>

<configBuilders>
  <builders>
    <add name="SampleConfigurationBuilder" type="CustomConfigBuilders.MyConfigBuilder, CustomConfigBuilders" />
  </builders>
</configBuilders>

<!-- To apply Configuration Builders to a configuration section, use the 'configBuilders' tag as follows:  -->
<appSettings configBuilders="SampleConfigurationBuilder">
  <add key="COMPUTERNAME" value="Will Be Replaced by EnvironmentVariable" />
</appSettings>

Комментарии

Производный от этого класса для чтения конфигурации из внешнего источника, который вы хотите использовать в приложении .NET Framework с помощью стандартного ConfigurationManager API.

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

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

Свойства

Имя	Описание
Description	Получает краткое понятное описание, подходящее для отображения в средствах администрирования или других пользовательских интерфейсах (UIs). (Унаследовано от ProviderBase)
Name	Возвращает понятное имя, используемое для ссылки на поставщика во время настройки. (Унаследовано от ProviderBase)

Методы

Имя	Описание
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
Initialize(String, NameValueCollection)	Инициализирует построитель конфигураций. (Унаследовано от ProviderBase)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ProcessConfigurationSection(ConfigurationSection)	ConfigurationSection Принимает объект из системы конфигурации и возвращает измененный или новый ConfigurationSection объект для дальнейшего использования.
ProcessRawXml(XmlNode)	XmlNode Принимает раздел необработанной конфигурации из файла конфигурации и возвращает измененный или новый XmlNode для дальнейшего использования.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)