ConfigurationBuilder ConfigurationBuilder ConfigurationBuilder ConfigurationBuilder Class

Definizione

Rappresenta la classe di base che deve essere estesa da implementazioni di generatori di configurazioni personalizzate.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
Ereditarietà
ConfigurationBuilderConfigurationBuilderConfigurationBuilderConfigurationBuilder

Esempi

Nell'esempio seguente viene illustrato come implementare un ConfigurationBuilder semplice per la lettura delle variabili di ambiente: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'esempio seguente è un estratto del file di configurazione che si applica all'esempio precedente.The following example is an excerpt of the configuration file as it applies to the previous example. Questa operazione applica le variabili di ambiente alla configurazione appSettings e rende disponibili tali ConfigurationManager.AppSettingsvalori in.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>

Commenti

Derivare da questa classe per leggere la configurazione da un'origine esterna che si desidera utilizzare nell'applicazione .NET Framework tramite l'API standard ConfigurationManager .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 sono disponibili in NuGet.org per la lettura da variabili di ambiente, Azure Key Vault e diverse altre origini.ConfigurationBuilders are available on NuGet.org to read from environment variables, Azure key vault, and a number of other sources.

Sono disponibili diverse implementazioni di ConfigurationBuilders da NuGet.org:Several implementations of ConfigurationBuilders are available from NuGet.org:

Costruttori

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

Inizializza una nuova istanza della classe ConfigurationBuilder.Initializes a new instance of the ConfigurationBuilder class.

Metodi

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

Determina se l'oggetto specificato è uguale all'oggetto corrente.Determines whether the specified object is equal to the current object.

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

Funge da funzione hash predefinita.Serves as the default hash function.

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

Ottiene l'oggetto Type dell'istanza corrente.Gets the Type of the current instance.

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

Inizializza il generatore di configurazione.Initializes the configuration builder.

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

Crea una copia superficiale dell'oggetto Object corrente.Creates a shallow copy of the current Object.

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

Accetta un oggetto ConfigurationSection dal sistema di configurazione e restituisce un oggetto ConfigurationSection nuovo o modificato per un uso futuro.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)

Accetta XmlNode che rappresenta la sezione di configurazione non elaborata di un file di configurazione e restituisce XmlNode modificato o nuovo per usi futuri.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()

Restituisce una stringa che rappresenta l'oggetto corrente.Returns a string that represents the current object.

(Inherited from Object)

Proprietà

Description Description Description Description

Ottiene una breve descrizione di facile comprensione che è possibile visualizzare in strumenti di amministrazione o in altre interfacce utente (UI, User Interface).Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

Ottiene il nome descrittivo utilizzato per fare riferimento al provider durante la configurazione.Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)

Si applica a