ConfigurationBuilder Třída

Definice

Obor názvů:

System.Configuration

Sestavení:

System.Configuration.dll

Představuje základní třídu, která má být rozšířena vlastními implementacemi tvůrce konfigurací.

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

Dědičnost

Object

ProviderBase

ConfigurationBuilder

Příklady

Následující příklad ukazuje, jak implementovat jednoduchý ConfigurationBuilder pro čtení proměnných prostředí:

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

Následující příklad je výňatek konfiguračního souboru, který se vztahuje na předchozí příklad. To aplikuje proměnné prostředí na konfiguraci appSettings a zpřístupní tyto hodnoty v části 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>

Poznámky

Odvozujte z této třídy ke čtení konfigurace z externího zdroje, který chcete použít v aplikaci .NET Framework pomocí standardního ConfigurationManager rozhraní API.

Konstruktory

Name	Description
ConfigurationBuilder()	Inicializuje novou instanci ConfigurationBuilder třídy.

Vlastnosti

Name	Description
Description	Získá stručný popis vhodný pro zobrazení v nástrojích pro správu nebo jiných uživatelských rozhraních (UI). (Zděděno od ProviderBase)
Name	Získá popisný název použitý k odkazování na zprostředkovatele během konfigurace. (Zděděno od ProviderBase)

Metody

Name	Description
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
Initialize(String, NameValueCollection)	Inicializuje tvůrce konfigurace. (Zděděno od ProviderBase)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ProcessConfigurationSection(ConfigurationSection)	ConfigurationSection Přijme objekt z konfiguračního systému a vrátí upravený nebo nový ConfigurationSection objekt pro další použití.
ProcessRawXml(XmlNode)	XmlNode Přijme reprezentaci nezpracovaného konfiguračního oddílu z konfiguračního souboru a vrátí upravenou nebo novou XmlNode část pro další použití.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)