ConfigurationBuilder Classe

Définition

Espace de noms:

System.Configuration

Assembly:

System.Configuration.dll

Représente la classe de base à étendre par les implémentations personnalisées du générateur de configuration.

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

Héritage

Object

ProviderBase

ConfigurationBuilder

Exemples

L’exemple suivant montre comment implémenter un Simple ConfigurationBuilder pour lire des variables d’environnement :

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

L’exemple suivant est un extrait du fichier de configuration tel qu’il s’applique à l’exemple précédent. Cela applique des variables d’environnement à la configuration appSettings et rend ces valeurs disponibles sous 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>

Remarques

Dérivez de cette classe pour lire la configuration à partir d’une source externe que vous souhaitez consommer dans votre application .NET Framework à l’aide de l’API standard ConfigurationManager .

Constructeurs

Nom	Description
ConfigurationBuilder()	Initialise une nouvelle instance de la classe ConfigurationBuilder.

Propriétés

Nom	Description
Description	Obtient une brève description conviviale adaptée à l’affichage dans les outils d’administration ou d’autres interfaces utilisateur (UIs). (Hérité de ProviderBase)
Name	Obtient le nom convivial utilisé pour faire référence au fournisseur pendant la configuration. (Hérité de ProviderBase)

Méthodes

Nom	Description
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
GetHashCode()	Sert de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
Initialize(String, NameValueCollection)	Initialise le générateur de configuration. (Hérité de ProviderBase)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
ProcessConfigurationSection(ConfigurationSection)	Accepte un ConfigurationSection objet du système de configuration et retourne un objet modifié ou nouveau ConfigurationSection pour une utilisation ultérieure.
ProcessRawXml(XmlNode)	Accepte une XmlNode représentation de la section de configuration brute à partir d’un fichier config et retourne une modification ou une nouvelle XmlNode version pour une utilisation ultérieure.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)