Paru le 06 septembre 2006
Matt Stoecker
Microsoft Corporation
Août 2006
S'applique à :
Microsoft Visual C# 2005
Microsoft .NET Framework 2.0
Résumé :Apprenez à utiliser les nouvelles fonctionnalités de Visual C# 2005 et à travailler avec les paramètres de portée application et utilisateur. (5 pages imprimées)
Lire cet article en anglais
Sur cette page
Introduction
Paramètres de portée application et utilisateur
Création de nouveaux paramètres au moment de la conception
Utilisation des paramètres lors de l'exécution
Utilisation d'ensembles de paramètres différents
Conclusion
Introduction
Le .NET Framework 2.0 vous permet de créer et d'accéder à des valeurs qui persistent d'une session d'exécution d'une application à une autre. Ces valeurs sont appelées paramètres. Ces paramètres peuvent correspondre à des préférences utilisateur ou à des informations nécessaires au fonctionnement de l'application. Par exemple, vous pouvez créer un ensemble de paramètres correspondant aux préférences utilisateur pour les couleurs d'une application. Vous pouvez également stocker la chaîne de connexion spécifiant une base de données utilisée par votre application. Les paramètres permettent à la fois de rendre persistantes des informations indispensables au fonctionnement de l'application autres que le code et de créer des profils pour stocker les préférences de chaque utilisateur.
Contrairement à Visual Basic 2005, Visual C# 2005 ne fournit pas de mécanisme de découverte aisée pour l'accès aux paramètres via l'espace de noms My ; il est donc un peu plus difficile d'accéder aux paramètres. Les utilisateurs de C# peuvent néanmoins accéder aux paramètres par le biais de l'espace de noms Properties. À la lecture de cet article, vous apprendrez à différencier les paramètres de portée application et utilisateur, à créer de nouveaux paramètres au moment de la conception, à accéder aux paramètres lors de l'exécution et à intégrer des ensembles de paramètres à votre application.
Paramètres de portée application et utilisateur
Les quatre propriétés des paramètres sont les suivantes :
-
Name : La propriété Name correspond au nom utilisé pour accéder à la valeur du paramètre lors de l'exécution.
-
Type : Le type du paramètre correspond au type .NET Framework que le paramètre représente. Un paramètre peut être de n'importe quel type. Par exemple, un paramètre contenant une préférence utilisateur relative aux couleurs serait du type System.Color.
-
Scope : La propriété Scope définit le mode d'accès au paramètre lors de l'exécution. La propriété Scope accepte deux valeurs : application et utilisateur. Celles-ci seront étudiées plus en détail dans cette section.
-
Value : La propriété Value correspond à la valeur renvoyée lors de l'accès au paramètre. La valeur est du type représenté par la propriété Type.
La plupart de ces propriétés sont relativement explicites. La plupart des programmeurs connaissent généralement les concepts associés aux propriétés Name, Type et Value. La propriété Scope nécessite cependant quelques explications supplémentaires. Il existe deux types de portée pour les paramètres : la portée application et la portée utilisateur. Les paramètres de portée application sont les paramètres utilisés par l'application, quelles que soient les préférences utilisateur. Les paramètres de portée utilisateur sont généralement moins significatifs pour l'application elle-même et sont plutôt associés aux préférences ou à d'autres valeurs non critiques.
La différence fondamentale entre ces deux paramètres est la suivante : les paramètres de portée utilisateur sont en lecture/écriture lors de l'exécution (leurs valeurs peuvent être modifiées et enregistrées dans le code), tandis que les paramètres de portée application sont en lecture seule lors de l'exécution. Ils sont accessibles en lecture, mais pas en écriture. Les paramètres de portée application ne peuvent être modifiés qu'au moment de la conception ou en éditant le fichier de paramètres manuellement.
Création de nouveaux paramètres au moment de la conception
Au moment de la conception, il est possible de créer de nouveaux paramètres à l'aide du Concepteur de paramètres. Doté d'une interface standard de type grille, il permet de créer de nouveaux paramètres et de spécifier des propriétés. Les propriétés Name, Type, Scope et Value doivent être spécifiées pour chaque paramètre. Une fois créé, un paramètre peut être évalué dans le code à l'aide des mécanismes décrits plus loin dans cet article.
Pour créer un nouveau paramètre au moment de la conception
-
Dans l'Explorateur de solutions, développez le nœud Propriétés de votre projet.
-
Dans l'Explorateur de solutions, double-cliquez sur le fichier .settings auquel vous voulez ajouter un nouveau paramètre. Le nom par défaut de ce fichier est Settings.settings.
-
Dans le Concepteur de paramètres, définissez les propriétés Name, Type, Scope et Value de votre paramètre. Chaque ligne représente un paramètre. La Figure 1 montre un exemple du Concepteur de paramètres.
Figure 1. Le Concepteur de paramètres dans Visual Studio 2005
Modification de la valeur d'un paramètre existant au moment de la conception
Le Concepteur de paramètres permet également de modifier la valeur d'un paramètre préexistant au moment de la conception, comme décrit dans les étapes suivantes :
Pour modifier la valeur d'un paramètre existant au moment de la conception
-
Dans l'Explorateur de solutions, développez le nœud Propriétés de votre projet.
-
Dans l'Explorateur de solutions, double-cliquez sur le fichier .settings auquel vous voulez ajouter un nouveau paramètre. Le nom par défaut de ce fichier est Settings.settings.
-
IDans le Concepteur de paramètres, recherchez le paramètre à modifier et tapez la nouvelle valeur dans la colonne correspondante.
Modification de la valeur d'un paramètre d'une session d'une application à une autre
Il peut arriver que vous souhaitiez modifier la valeur d'un paramètre d'une session d'application à une autre, une fois l'application compilée et déployée, par exemple, si vous voulez modifier une chaîne de connexion de sorte qu'elle pointe vers l'emplacement de base de données correct. Les outils de conception n'étant pas disponibles après la compilation et le déploiement d'une application, vous devez modifier la valeur du paramètre manuellement dans le fichier.
Pour modifier la valeur d'un paramètre d'une session d'application à une autre
-
À l'aide du Bloc-Notes Microsoft ou d'un autre éditeur de texte ou XML, ouvrez le fichier <NomAssembly>.exe.config associé à votre application.
-
Localisez l'entrée correspondant au paramètre à modifier. Elle doit se présenter comme suit :
<setting name="Setting" serializeAs="String">
<value>This is the setting value</value>
</setting>
Utilisation des paramètres lors de l'exécution
Lors de l'exécution, l'application peut accéder aux paramètres par le biais du code. Vous pouvez accéder en lecture seule aux valeurs de paramètres de portée application et en lecture/écriture aux valeurs de paramètres de portée utilisateur. Les paramètres sont accessibles dans C# via l'espace de noms Properties.
Lecture des paramètres lors de l'exécution
Lors de l'exécution, les paramètres de portée application et utilisateur sont accessibles en lecture via l'espace de noms Properties. Grâce à l'objet Properties.Settings.Default, cet espace de noms affiche tous les paramètres par défaut du projet. Lorsque vous écrivez du code nécessitant des paramètres, tous les paramètres s'affichent dans IntelliSense et sont fortement typés. Ainsi, si un paramètre est de type System.Drawing.Color, par exemple, vous pouvez l'utiliser sans le convertir, comme indiqué dans l'exemple suivant :
this.BackColor = Properties.Settings.Default.myColor;
Enregistrement des paramètres utilisateur lors de l'exécution
Les paramètres de portée application sont en lecture seule et ne peuvent être modifiés qu'au moment de la conception ou en éditant le fichier <NomAssembly>.exe.config entre deux sessions de l'application. Les paramètres de portée utilisateur peuvent quant à eux être écrits lors de l'exécution, de la même façon que les valeurs de propriété. Les nouvelles valeurs sont conservées pendant la durée de la session de l'application. Vous pouvez conserver les modifications apportées aux paramètres utilisateur d'une session de l'application à une autre en appelant la méthode Settings.Save. Ces paramètres sont enregistrés dans le fichier User.config.
Pour écrire et conserver des paramètres utilisateur lors de l'exécution
Properties.Settings.Default.myColor = Color.AliceBlue;
Properties.Settings.Default.Save();
Utilisation d'ensembles de paramètres différents
Dans certains cas, vous pouvez avoir besoin de plusieurs ensembles de paramètres dans une application. Par exemple, si vous développez une application dans laquelle un certain groupe de paramètres est amené à changer fréquemment, il peut s'avérer judicieux de les regrouper dans un fichier unique distinct afin que ce dernier puisse être remplacé globalement, sans affecter les autres paramètres. Visual Studio 2005 vous permet d'ajouter plusieurs ensembles de paramètres à votre projet. Vous pouvez accéder à ces ensembles à l'aide de l'objet de paramètres généré dans leur propre nœud. Par exemple, si vous ajoutez un ensemble de paramètres nommé SpecialSettings à votre projet, vous accédez aux paramètres qu'il contient dans le code au moyen de l'objet Properties.SpecialSettings.
Pour ajouter un ensemble de paramètres
-
Dans le menu Projet, sélectionnez Ajouter un nouvel élément. La boîte de dialogue Ajouter un nouvel élément s'ouvre.
-
Dans cette boîte de dialogue, sélectionnez Fichier de paramètres.
-
Dans la zone Nom, entrez le nom du fichier de paramètres, par exemple SpecialSettings.settings, puis cliquez sur Ajouter pour ajouter le fichier à la solution.
-
Dans l'Explorateur de solutions, faîtes glisser le nouveau fichier de paramètres dans le dossier Propriétés. Ainsi, vos nouveaux paramètres apparaissent dans le code.
-
Ajoutez et utilisez les paramètres de ce fichier comme vous le feriez avec tout autre fichier de paramètres. Vous pouvez accéder à ce groupe de paramètres à l'aide de l'objet Properties.SpecialSettings.
Conclusion
Cet article vous a permis de découvrir comment enregistrer et gérer des paramètres liés à la fois à l'application et à l'utilisateur dans vos applications C#. Vous avez appris comment ajouter des paramètres au moment de la conception, comment lire et écrire des paramètres lors de l'exécution et comment incorporer des ensembles de paramètres supplémentaires à votre application. Pour plus d'informations, consultez les ressources suivantes :
Windows Forms dans le Centre développeur Microsoft .NET Framework
WindowsForms.NET
Blog Mises à jour de la documentation Windows Forms (en anglais)