Le moyen le plus simple d'avoir un fichier de configuration dans une application Windows Forms C#

Question

Je suis vraiment novice en .NET, et je n'ai toujours pas compris le fonctionnement des fichiers de configuration.

Chaque fois que je fais une recherche sur Google à ce sujet, je reçois des résultats concernant web.config, mais j'écris une application Windows Forms.

J'ai compris que je devais utiliser l'espace de noms System.Configuration, mais la documentation ne m'aide pas.

Comment puis-je définir que mon fichier de configuration est XYZ.xml ? Ou existe-t-il un nom "par défaut" pour le fichier de configuration ? Je n'ai toujours pas compris.

Par ailleurs, comment puis-je définir une nouvelle section ? Dois-je vraiment créer une classe qui hérite de ConfigurationSection ?

Je voudrais simplement avoir un fichier de configuration avec quelques valeurs comme ceci :

<MyCustomValue>1</MyCustomValue>
<MyCustomPath>C:\Some\Path\Here</MyCustomPath>

Existe-t-il un moyen simple de le faire ? Pouvez-vous expliquer de manière simple comment lire et écrire depuis/vers un simple fichier de configuration ?

Answer 1

Vous voulez utiliser une App.Config.

Lorsque vous ajoutez un nouvel élément à un projet, il existe un élément appelé fichier de configuration des applications. Ajoutez-le.

Ensuite, vous ajoutez des clés dans la section configuration/appsettings

Comme :

<configuration>
 <appSettings>
  <add key="MyKey" value="false"/>

Accédez aux membres en faisant

System.Configuration.ConfigurationSettings.AppSettings["MyKey"];

Cela fonctionne dans .NET 2 et plus.

Answer 2

Clarification des réponses précédentes...

1. Ajoutez un nouveau fichier à votre projet ( Ajouter → Nouvel article → Fichier de configuration de l'application )

2. Le nouveau fichier de configuration apparaîtra dans Solution Explorer sous la forme suivante App.Config .

3. Ajoutez vos paramètres dans ce fichier en utilisant ce qui suit comme modèle

   <configuration>
     <appSettings>
       <add key="setting1" value="key"/>
     </appSettings>
     <connectionStrings>
       <add name="prod" connectionString="YourConnectionString"/>
     </connectionStrings>
   </configuration>

4. Récupérez-les comme ceci :

   private void Form1_Load(object sender, EventArgs e)
   {
       string setting = ConfigurationManager.AppSettings["setting1"];
       string conn = ConfigurationManager.ConnectionStrings["prod"].ConnectionString;
   }

5. Une fois construit, votre dossier de sortie contiendra un fichier appelé <nom de l'assemblage>.exe.config. Il s'agira d'une copie du fichier App.Config fichier. Le développeur ne devrait pas avoir à effectuer d'autres travaux pour créer ce fichier.

Answer 3

Après une lecture rapide des réponses précédentes, elles semblent correctes, mais il semble que personne n'ait mentionné les nouvelles fonctions de configuration de Visual Studio 2008. Il utilise toujours app.config (copié au moment de la compilation dans YourAppName.exe.config), mais il existe un widget de l'interface utilisateur permettant de définir les propriétés et de spécifier leurs types. Double-cliquez sur Paramètres. dans le dossier "Propriétés" de votre projet.

La meilleure chose est que l'accès à cette propriété à partir du code est sûr - le compilateur détectera les erreurs évidentes comme la mauvaise saisie du nom de la propriété. Par exemple, une propriété appelée MyConnectionString dans le code app.config serait accessible comme :

string s = Properties.Settings.Default.MyConnectionString;

Answer 4

Le nom par défaut d'un fichier de configuration est [yourexe].exe.config. Ainsi, notepad.exe aura un fichier de configuration nommé notepad.exe.config, dans le même dossier que le programme. Il s'agit d'un fichier de configuration général pour tous les aspects du CLR et du Framework, mais il peut contenir vos propres paramètres sous un nom d'utilisateur. <appSettings> nœud.

El <appSettings> crée une collection de paires nom-valeur auxquelles on peut accéder en tant que System.Configuration.ConfigurationSettings.AppSettings . Il n'y a cependant aucun moyen de sauvegarder les modifications dans le fichier de configuration.

Il est également possible d'ajouter vos propres éléments personnalisés à un fichier de configuration - par exemple, pour définir un paramètre structuré - en créant une classe qui met en œuvre la fonction IConfigurationSectionHandler et l'ajouter à la <configSections> du fichier de configuration. Vous pouvez ensuite y accéder en appelant ConfigurationSettings.GetConfig .

.NET 2.0 ajoute une nouvelle classe, System.Configuration.ConfigurationManager qui prend en charge de multiples fichiers, avec des remplacements de données par utilisateur pour les données du système. Il permet également de sauvegarder les configurations modifiées dans les fichiers de paramètres.

Visual Studio crée un fichier appelé App.config qu'il copie dans le dossier EXE, avec le nom correct, lorsque le projet est construit.

Answer 5

Le meilleur article (IMHO) sur la configuration des applications .NET se trouve sur CodeProject, Lever le voile sur les mystères de la configuration de .NET 2.0 . Et mon autre article préféré (plus court) sur les sections des fichiers de configuration .NET est le suivant Comprendre les gestionnaires de section - Fichier App.config .