ConfigurationBuilder Osztály

Definíció

Névtér:

System.Configuration

Szerelvény:

System.Configuration.dll

Az egyéni konfigurációkészítő implementációk által bővítendő alaposztályt jelöli.

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

Öröklődés

Object

ProviderBase

ConfigurationBuilder

Példák

Az alábbi példa bemutatja, hogyan implementálhat egy egyszerű ConfigurationBuildert a környezeti változók olvasásához:

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

Az alábbi példa a konfigurációs fájl egy részlete, amely az előző példára vonatkozik. Ez környezeti változókat alkalmaz az appSettings konfigurációra, és elérhetővé teszi ezeket az értékeket a következő alatt 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>

Megjegyzések

Ebből az osztályból származtatva beolvashatja a konfigurációt egy külső forrásból, amelyet a .NET-keretrendszeralkalmazásban a standard ConfigurationManager API használatával szeretne használni.

Konstruktorok

Name	Description
ConfigurationBuilder()	Inicializálja a ConfigurationBuilder osztály új példányát.

Tulajdonságok

Name	Description
Description	Rövid, rövid leírást kap, amely alkalmas a felügyeleti eszközökben vagy más felhasználói felületeken való megjelenítésre. (Öröklődés forrása ProviderBase)
Name	Lekéri a szolgáltatóra való hivatkozáshoz használt rövid nevet a konfiguráció során. (Öröklődés forrása ProviderBase)

Metódusok

Name	Description
Equals(Object)	Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal. (Öröklődés forrása Object)
GetHashCode()	Ez az alapértelmezett kivonatoló függvény. (Öröklődés forrása Object)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
Initialize(String, NameValueCollection)	Inicializálja a konfigurációszerkesztőt. (Öröklődés forrása ProviderBase)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ProcessConfigurationSection(ConfigurationSection)	Elfogad egy ConfigurationSection objektumot a konfigurációs rendszerből, és egy módosított vagy új ConfigurationSection objektumot ad vissza további használatra.
ProcessRawXml(XmlNode)	Elfogad egy XmlNode konfigurációs fájlból származó nyers konfigurációs szakaszt, és egy módosított vagy újat XmlNode ad vissza további használatra.
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)