section, élément de configSections (Schéma des paramètres généraux)

Article
09/04/2008

Mise à jour : novembre 2007

Définit une association entre un gestionnaire de section de configuration et un élément de configuration.

configuration, élément (Schéma des paramètres généraux)
  configSections, élément (Schéma des paramètres généraux)
    section, élément de configSections (Schéma des paramètres généraux)
      configuration, élément (Schéma des paramètres généraux)
        configSections, élément (Schéma des paramètres généraux)
          sectionGroup, élément de configSections (Schéma des paramètres généraux)
            section, élément de configSections (Schéma des paramètres généraux)

<section 
   name="section name"
   type="configuration section handler class, assembly file name, version, culture, public key token"
   allowDefinition= "Everywhere|MachineOnly|MachineToApplication|MachineToWebRoot" 
   allowLocation="True|False" 
   restartOnExternalChanges="True|False" 
/>

Attributs et éléments

Les sections suivantes décrivent des attributs, des éléments enfants et des éléments parents.

Attributs

Attribut

Description

allowDefinition

Attribut Enum facultatif.

S'applique uniquement aux applications ASP.NET.

Spécifie le fichier de configuration dans lequel la section peut être utilisée.

Cet attribut peut avoir l'une des valeurs suivantes (définies dans l'énumération ConfigurationAllowDefinition) par ordre de portée décroissante.

Valeur	Description
Everywhere	Autorise la configuration de la section dans n'importe quel fichier de configuration ou répertoire, comme suit : Machine.config Web.config racine Web.config d'une application Répertoire virtuel Sous-répertoire physique de l'application Si aucun attribut allowDefinition n'est utilisé, Everywhere est la valeur supposée. Il s'agit de l'option par défaut.
MachineToApplication	Autorise la configuration de la section dans l'un des fichiers suivants : Machine.config Web.config racine Web.config d'une application Cela exclut les fichiers Web.config placés dans des répertoires virtuels ou un sous-répertoire physique de l'application.
MachineToWebRoot	Autorise la configuration de la section dans l'un des fichiers suivants : Machine.config Web.config racine Les fichiers Machine.config et Web.config racine sont tous deux situés dans %SystemRoot%\Microsoft.NET\Framework\NuméroVersion\CONFIG.
MachineOnly	Autorise la section à être configurée uniquement dans le fichier Machine.config, situé dans %SystemRoot%\Microsoft.NET\Framework\NuméroVersion\CONFIG.

allowExeDefinition

Attribut Enum facultatif.

S'applique uniquement aux applications clientes du .NET Framework.

Spécifie le fichier de configuration dans lequel la section peut être utilisée.

Cet attribut peut avoir l'une des valeurs suivantes (définies dans l'énumération ConfigurationAllowExeDefinition) par ordre de portée décroissante.

Valeur	Description
MachineToApplication	Autorise la configuration de la section dans l'un des fichiers suivants : Machine.config Configuration d'application
MachineToRoamingUser
MachineToLocalUser
MachineOnly	Autorise la section à être configurée uniquement dans le fichier Machine.config, situé dans %SystemRoot%\Microsoft.NET\Framework\NuméroVersion\CONFIG.

allowLocation

Attribut Boolean facultatif.

S'applique uniquement aux applications ASP.NET.

Indique si la section peut être utilisée dans l'élément location.

La valeur par défaut est True.

name

Attribut String requis.

Spécifie le nom de la section ou de l'élément de configuration associé au gestionnaire de section de configuration qui est spécifié dans l'attribut type. Il s'agit du nom de l'élément tel qu'il apparaît dans la zone des paramètres de sections du fichier de configuration.

restartOnExternalChanges

Attribut Boolean facultatif.

Ne s'applique pas aux applications ASP.NET.

Spécifie si l'application doit redémarrer, en cas de modification des données de configuration de la section.

type

Attribut String requis.

Spécifie le nom de la classe du gestionnaire de section de configuration qui gère le traitement des paramètres de configuration présents dans la section ou l'élément spécifié dans l'attribut name. Utilisez le format suivant :

type="Nom de classe qualifié complet, nom de fichier de l'assembly., version, culture, jeton de clé publique"

La définition doit correspondre à la référence d'assembly. Par exemple, si le numéro de version dans l'exemple de syntaxe suivant ne correspond pas à l'assembly, une erreur se produit.

type="MyConfigSectionHandler.MyHandler,MyCustomConfigurationHandler,Version=1.0.0.0,Culture=neutral,PublicKeyToken=null"

Le fichier d'assembly doit se trouver dans le même répertoire d'application que le fichier Web.config qui le définit. Dans le cas du fichier Web.config racine ou du fichier Machine.config, le fichier d'assembly doit être dans le répertoire %SystemRoot%\Microsoft.NET\Framework\version.

Éléments enfants

Aucun

Éléments parents

Élément	Description
configuration	Spécifie l'élément racine requis dans chaque fichier de configuration utilisé par le Common Language Runtime et les applications .NET Framework.
configSections	Spécifie une section de configuration et des déclarations d'espace de noms.
sectionGroup	Définit une association entre un gestionnaire de section de configuration et une section de configuration.

Notes

Un élément section associe un gestionnaire de section de configuration à un élément ou une section de configuration. Cela est nécessaire parce qu'ASP.NET ne fait aucune supposition quant à la gestion de paramètres dans un fichier de configuration. Au lieu de cela, ASP.NET délègue le traitement des données de configuration aux gestionnaires de section de configuration. Chaque élément section identifie une section ou un élément de configuration et la classe associée dérivée de la classe ConfigurationSection qui gère la section ou l'élément de configuration. Les éléments section peuvent être groupés logiquement dans des éléments sectionGroup pour bénéficier d'une meilleure organisation et éviter des conflits de noms. Les éléments section et sectionGroup sont contenus dans l'élément configSections.

Configuration par défaut

Les sections de configuration des éléments de configuration du .NET Framework sont définies dans le fichier Machine.config et sont trop nombreuses pour être répertoriées ici. L'extrait du fichier Machine.config suivant définit le gestionnaire de section de configuration de l'élément authentication de la section system.web. Ensuite, les paramètres de configuration sont définis pour l'élément authentication.

Si un gestionnaire de section de configuration n'est pas associé à un élément de configuration, ASP.NET publie l'erreur de serveur, « Section de configuration non reconnue nom_élément ».

<configuration>
    <configSections>
        <sectionGroup name="system.web" type="System.Web.Configuration.SystemWebSectionGroup, System.Web, Version=%ASSEMBLY_VERSION%, Culture=neutral, PublicKeyToken=%MICROSOFT_PUBLICKEY%">
            <section name="authentication" type="System.Web.Configuration.AuthenticationSection, System.Web, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" allowDefinition="MachineToApplication" />
            <!-- Other system.web sections -->
        </sectionGroup>
        <!-- Other configuration sections -->
    </configSections>

    <system.web>
        <authentication mode="Windows">
            <forms name=".ASPXAUTH" 
                   loginUrl="login.aspx" defaultUrl="default.aspx" 
                   protection="All" 
                   timeout="30" 
                   path="/" 
                   requireSSL="False" 
                   slidingExpiration="True" 
                   cookieless="UseCookies" 
                   domain="" 
                   enableCrossAppRedirects="False">
                <credentials passwordFormat="SHA1" />
            </forms>
            <passport redirectUrl="internal" />
        </authentication>
        <!-- Other system.web elements -->
    </system.web>
    <!-- Other configuration settings -->
</configuration>

Exemple

L'exemple de code suivant montre comment définir une section de configuration personnalisée et les paramètres de cette section.

<configuration>

   <configSections>
      <section name="sampleSection"
               type="System.Configuration.SingleTagSectionHandler" />
   </configSections>

   <sampleSection setting1="Value1" 
                  setting2="value two" 
                  setting3="third value" />

</configuration>

Informations sur les éléments

Gestionnaire de section de configuration	Non applicable.
Membre de configuration	ConfigurationSection
Emplacements configurables	Machine.config Web.config racine Web.config au niveau de l'application Web.config de niveau répertoire virtuel ou physique
Configuration requise	Microsoft Internet Information Services (IIS) 5.0, 5.1 ou 6.0 .NET Framework version 1.0, 1.1 ou 2.0 Microsoft Visual Studio 2003 ou Visual Studio 2005

Voir aussi

Partager via