appSettings, élément (Schéma des paramètres généraux)

Article
09/04/2008

Mise à jour : novembre 2007

Contient des paramètres d'application personnalisés, tels que des chemins d'accès, des URL de service Web XML ou des informations stockées dans le fichier .ini d'une application.

configuration, élément (Schéma des paramètres généraux)
appSettings, élément (Schéma des paramètres généraux)

<appSettings
   file="relative file name" >
</appSettings>

Attributs et éléments

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

Attributs

Élément	Description
file	Attribut String facultatif. Spécifie un chemin d'accès relatif à un fichier externe qui contient des paramètres de configuration d'application personnalisés. Le fichier spécifié contient le même type de paramètres que ceux qui sont spécifiés dans les attributs add, clear et remove de appSettings et utilise le même format de paire clé/valeur que ces éléments. Le chemin d'accès spécifié est relatif par rapport au fichier de configuration local. Le runtime ignore l'attribut si le fichier spécifié est introuvable. Dans la mesure où toute modification du fichier Web.config provoque le redémarrage de l'application, l'utilisation d'un fichier distinct permet aux utilisateurs de modifier des valeurs figurant dans la section appSettings sans entraîner le redémarrage de l'application. Le contenu du fichier distinct est fusionné avec la section appSettings du fichier Web.config. Cette fonctionnalité est limitée à l'attribut appSettings. Remarque Dans le .NET Framework version 2.0, vous pouvez maintenant inclure des paramètres de configuration dans un fichier distinct pour tous les éléments de configuration qui prennent en charge l'attribut configSource. Toutefois, lorsque vous utilisez l'attribut configSource, vous devez déplacer la section entière dans le fichier distinct car les paramètres des éléments ne sont pas fusionnés. Le fichier Web.config fait l'objet d'une seule écriture lors de l'utilisation de l'attribut configSource. Cela provoque le redémarrage de l'application, mais les mises à jour suivantes apportées à la section sont écrites directement dans le fichier distinct et n'entraînent pas de redémarrages consécutifs de l'application. Pour plus d'informations, consultez ConfigSource.
Attributs hérités	Attributs facultatifs. Attributs hérités par tous les éléments Section.

file

Attribut String facultatif.

Spécifie un chemin d'accès relatif à un fichier externe qui contient des paramètres de configuration d'application personnalisés. Le fichier spécifié contient le même type de paramètres que ceux qui sont spécifiés dans les attributs add, clear et remove de appSettings et utilise le même format de paire clé/valeur que ces éléments.

Le chemin d'accès spécifié est relatif par rapport au fichier de configuration local. Le runtime ignore l'attribut si le fichier spécifié est introuvable.

Dans la mesure où toute modification du fichier Web.config provoque le redémarrage de l'application, l'utilisation d'un fichier distinct permet aux utilisateurs de modifier des valeurs figurant dans la section appSettings sans entraîner le redémarrage de l'application. Le contenu du fichier distinct est fusionné avec la section appSettings du fichier Web.config. Cette fonctionnalité est limitée à l'attribut appSettings.

Remarque Dans le .NET Framework version 2.0, vous pouvez maintenant inclure des paramètres de configuration dans un fichier distinct pour tous les éléments de configuration qui prennent en charge l'attribut configSource. Toutefois, lorsque vous utilisez l'attribut configSource, vous devez déplacer la section entière dans le fichier distinct car les paramètres des éléments ne sont pas fusionnés. Le fichier Web.config fait l'objet d'une seule écriture lors de l'utilisation de l'attribut configSource. Cela provoque le redémarrage de l'application, mais les mises à jour suivantes apportées à la section sont écrites directement dans le fichier distinct et n'entraînent pas de redémarrages consécutifs de l'application. Pour plus d'informations, consultez ConfigSource.

Attributs hérités

Attributs facultatifs.

Attributs hérités par tous les éléments Section.

Éléments enfants

Élément	Description
add	Élément facultatif. Ajoute un paramètre d'application personnalisé en tant que paire nom/valeur à la collection de paramètres d'application.
clear	Élément facultatif. Supprime toutes les références aux paramètres d'application personnalisés hérités et autorise uniquement les références ajoutées par l'attribut add actuel.
remove	Élément facultatif. Supprime une référence à un paramètre d'application personnalisé hérité de la collection des paramètres d'application.

add

Élément facultatif.

Ajoute un paramètre d'application personnalisé en tant que paire nom/valeur à la collection de paramètres d'application.

clear

Élément facultatif.

Supprime toutes les références aux paramètres d'application personnalisés hérités et autorise uniquement les références ajoutées par l'attribut add actuel.

remove

Élément facultatif.

Supprime une référence à un paramètre d'application personnalisé hérité de la collection des paramètres d'application.

É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.
system.web	Spécifie l'élément racine des paramètres de configuration ASP.NET dans un fichier de configuration et contient des éléments de configuration qui configurent des applications Web ASP.NET et contrôlent le comportement des applications.

Notes

L'élément appSettings contient des informations de configuration d'application personnalisées, telles que des chemins d'accès, des URL de service Web XML ou des informations stockées dans le fichier .ini d'une application. Les paires clé/valeur spécifiées dans l'élément appSettings sont accessibles dans le code à l'aide de la classe ConfigurationSettings.

Vous pouvez utiliser l'attribut file pour spécifier un fichier de configuration qui fournit des paramètres supplémentaires ou se substitue aux paramètres spécifiés dans l'élément appSettings. Vous pouvez utiliser l'attribut file dans les scénarios de développement en équipe de contrôle de code source, par exemple lorsqu'un utilisateur souhaite substituer les paramètres du projet spécifiés dans un fichier de configuration de l'application. Les fichiers de configuration spécifiés dans un attribut file doivent avoir l'élément appSettings plutôt que l'élément configuration comme nœud racine.

Dans les applications du .NET Framework version 2.0, stockez les chaînes de connexion à une base de données dans la collection connectionStrings, élément (Schéma des paramètres ASP.NET) au lieu de la collection des paramètres d'application.

Configuration par défaut

L'élément appSettings par défaut n'est pas configuré explicitement dans le fichier Machine.config ou dans le fichier Web.config racine. Toutefois, il s'agit de la configuration par défaut retournée par l'application.

   <appSettings file="">
      <settings>
         <clear />
      </settings>
   </appSettings>

Exemple

Les fichiers de configuration spécifiés dans un attribut file doivent avoir l'élément appSettings plutôt que l'élément configuration comme nœud racine.

L'exemple de code suivant montre comment utiliser la forme correcte d'un fichier de configuration spécifié dans l'attribut file.

<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="Application1" value="MyApplication1" />
<add key="Setting1" value="MySetting" />
</appSettings>

L'exemple de code suivant montre comment définir un paramètre d'application personnalisé dans un fichier de configuration.

<configuration>
    <appSettings>
        <add key="Application Name" value="MyApplication" />
    </appSettings>
</configuration>

Informations sur les éléments

Gestionnaire de section de configuration	AppSettingsSection
Membre de configuration	AppSettings AppSettings AppSettings
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

appSettings, élément (Schéma des paramètres généraux)

Attributs et éléments

Attributs

Éléments enfants

Éléments parents

Notes

Configuration par défaut

Exemple

Informations sur les éléments

Voir aussi

Concepts

Référence

Autres ressources

Ressources supplémentaires