ConfigurationBuilder ConfigurationBuilder ConfigurationBuilder ConfigurationBuilder Class

Définition

Représente la classe de base à étendre par des implémentations de générateur de configuration personnalisées.Represents the base class to be extended by custom configuration builder implementations.

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
ConfigurationBuilderConfigurationBuilderConfigurationBuilderConfigurationBuilder

Exemples

L’exemple suivant montre comment implémenter un ConfigurationBuilder simple pour lire les variables d’environnement :The following example shows how to implement a simple ConfigurationBuilder to read Environment variables:

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.The following example is an excerpt of the configuration file as it applies to the previous example. Cela s’applique des variables d’environnement à la configuration appSettings et rend ces valeurs disponibles sous ConfigurationManager.AppSettings.This applies environment variables to the appSettings configuration and makes those values available under 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ériver de cette classe pour lire la configuration d’une source externe que vous souhaitez utiliser dans votre application .NET Framework à l’aide de la norme ConfigurationManager API.Derive from this class to read configuration from an external source that you would like to consume in your .NET Framework application using the standard ConfigurationManager API. ConfigurationBuilders sont disponibles sur NuGet.org pour lire à partir de variables d’environnement, coffre de clés Azure et un nombre d’autres sources.ConfigurationBuilders are available on NuGet.org to read from environment variables, Azure key vault, and a number of other sources.

Plusieurs implémentations de ConfigurationBuilders sont disponibles à partir de NuGet.org :Several implementations of ConfigurationBuilders are available from NuGet.org:

Constructeurs

ConfigurationBuilder() ConfigurationBuilder() ConfigurationBuilder() ConfigurationBuilder()

Initialise une nouvelle instance de la classe ConfigurationBuilder.Initializes a new instance of the ConfigurationBuilder class.

Méthodes

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection)

Initialise le générateur de configuration.Initializes the configuration builder.

(Inherited from ProviderBase)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle du Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
ProcessConfigurationSection(ConfigurationSection) ProcessConfigurationSection(ConfigurationSection) ProcessConfigurationSection(ConfigurationSection) ProcessConfigurationSection(ConfigurationSection)

Accepte un objet ConfigurationSection à partir du système de configuration et retourne un objet ConfigurationSection nouveau ou modifié pour une utilisation ultérieure.Accepts a ConfigurationSection object from the configuration system and returns a modified or new ConfigurationSection object for further use.

ProcessRawXml(XmlNode) ProcessRawXml(XmlNode) ProcessRawXml(XmlNode) ProcessRawXml(XmlNode)

Accepte un XmlNode représentant la section de configuration brute d’un fichier de configuration, et retourne un XmlNode nouveau ou modifié pour une utilisation ultérieure.Accepts an XmlNode representing the raw configuration section from a config file and returns a modified or new XmlNode for further use.

ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

Propriétés

Description Description Description Description

Obtient une description brève et conviviale qui peut s'afficher dans les outils d'administration ou d'autres interfaces utilisateur.Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

Obtient le nom convivial qui référence le fournisseur au cours de la configuration.Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)

S’applique à