Créer une catégorie de paramètres
Dans ce didacticiel, vous créez une catégorie de paramètres Visual Studio et l’utilisez pour sauvegarder des valeurs dans un fichier de paramètres et les restaurer à partir de celui-ci. Une catégorie de paramètres est un groupe de propriétés apparentées qui apparaissent comme un « point de paramètres personnalisés »; c’est-à-dire, comme une case à cocher dans l’assistant Importer et exporter les paramètres. (Vous pouvez le trouver dans le menu Outils.) Les paramètres sont sauvegardés ou restaurés en tant que catégorie, et les paramètres individuels ne sont pas affichés dans l’assistant. Pour plus d’informations, consultez Paramètres d’environnement.
Vous créez une catégorie de paramètres en la dérivant de la classe DialogPage.
Pour commencer ce didacticiel, vous devez d’abord compléter la première section de Créer une page d’options. La grille des propriétés résultante vous permet d’examiner et de modifier les propriétés de la catégorie. Après avoir sauvegardé la catégorie de propriété dans un fichier de paramètres, vous examinez le fichier pour voir comment les valeurs des propriétés sont stockées.
Créer une catégorie de paramètres
Dans cette section, vous utilisez un point de paramètres personnalisés pour sauvegarder et restaurer les valeurs de la catégorie de paramètres.
Pour créer une catégorie de paramètres
Complétez Créer une page d’options.
Ouvrez le fichier VSPackage.resx et ajoutez ces trois ressources de chaîne :
Nom Valeur 106 Ma Catégorie 107 Mes paramètres 108 OptionInteger et OptionFloat Cela crée des ressources qui nomment la catégorie « Ma Catégorie », l’objet « Mes Paramètres », et la description de la catégorie « OptionInteger et OptionFloat ».
Remarque
De ces trois, seul le nom de la catégorie n’apparaît pas dans l’assistant Importer et exporter les paramètres.
Dans MyToolsOptionsPackage.cs, ajoutez une propriété
floatnomméeOptionFloatà la classeOptionPageGrid, comme montré dans l’exemple suivant.public class OptionPageGrid : DialogPage { private int optionInt = 256; private float optionFloat = 3.14F; [Category("My Options")] [DisplayName("My Integer option")] [Description("My integer option")] public int OptionInteger { get { return optionInt; } set { optionInt = value; } } [Category("My Options")] [DisplayName("My Float option")] [Description("My float option")] public float OptionFloat { get { return optionFloat; } set { optionFloat = value; } } }Remarque
La catégorie
OptionPageGridnommée « Ma Catégorie » consiste maintenant en deux propriétés,OptionIntegeretOptionFloat.Ajoutez un ProvideProfileAttribute à la classe
MyToolsOptionsPackageet donnez-lui le CategoryName « Ma Catégorie », donnez-lui le ObjectName « Mes Paramètres », et paramétrez isToolsOptionPage sur true. Ajustez categoryResourceID, objectNameResourceID, et DescriptionResourceID sur les IDs de ressources de chaîne créées plus tôt.[ProvideProfileAttribute(typeof(OptionPageGrid), "My Category", "My Settings", 106, 107, isToolsOptionPage:true, DescriptionResourceID = 108)]Générez le projet et commencez le débogage. Dans l’instance expérimentale, vous devriez voir que Ma Page de Grille a maintenant des valeurs entières et flottantes.
Examinez le fichier de paramètres
Dans cette section, vous exportez les valeurs de la catégorie de propriété dans un fichier de paramètres. Vous examinez le fichier puis importez les valeurs de retour dans la catégorie de propriété.
Démarrez le projet en mode débogage en appuyant sur F5. Cela démarre l’instance expérimentale.
Ouvrez la boîte de dialogue Outils>Options.
Dans l’arborescence dans le volet gauche, développez Ma Catégorie puis cliquez sur Ma Page de Grille.
Changez la valeur de OptionFloat en 3.1416 et OptionInteger en 12. Cliquez sur OK.
Dans le menu Outils, cliquez sur Importation et exportation des paramètres.
L’assistant Importer et exporter les paramètres apparaît.
Assurez-vous que Exporter les paramètres de l’environnement sélectionnés est sélectionné, puis cliquez sur Suivant.
La page Choisir les paramètres à exporter apparaît.
Cliquez sur Mes Paramètres.
La Description change pour OptionEntier et OptionFlottant.
Assurez-vous que Mes Paramètres est la seule catégorie sélectionnée, puis cliquez sur Suivant.
La page Nommez votre fichier de paramètres apparaît.
Nommez le nouveau fichier de paramètres MySettings.vssettings et enregistrez-le dans un répertoire approprié. Cliquez sur Terminer.
Le fichier
.vssettingsest le fichier de paramètres Visual Studio. Le schéma du fichier est ouvert. Le plus souvent, le schéma suit une structure XML où chaque catégorie est une balise, qui peut elle-même contenir des balises de sous-catégorie. Ces tags de sous-catégorie peuvent contenir des tags de valeur de propriété. Alors que la plupart des packages utilisent la structure commune, n’importe quel package dans Visual Studio peut contribuer arbitrairement au fichier avec le schéma de son choix.La page Exportation complète rapporte que vos paramètres ont été exportés avec succès.
Dans le menu Fichier , pointez sur Ouvrir, puis cliquez sur Fichier. Localisez MySettings.vssettings et ouvrez-le.
Vous pouvez trouver la catégorie de propriété que vous avez exportée dans la section suivante du fichier (vos GUID seront différents).
<Category name="My Category_My Settings" Category="{4802bc3e-3d9d-4591-8201-23d1a05216a6}" Package="{6bb6942e-014c-489e-a612-a935680f703d}" RegisteredName="My Category_My Settings"> PackageName="MyToolsOptionsPackage"> <PropertyValue name="OptionFloat">3.1416</PropertyValue> <PropertyValue name="OptionInteger">12</PropertyValue> </Category>Remarquez que le nom complet de la catégorie est formé par l’ajout d’un trait de soulignement au nom de la catégorie suivi du nom de l’objet. OptionFloat et OptionInteger apparaissent dans la catégorie, avec leurs valeurs exportées.
Fermez le fichier de paramètres sans le modifier.
Dans le menu Outils, cliquez sur Options, développez Ma Catégorie, cliquez sur Ma Page de Grille et changez ensuite la valeur de OptionFloat en 1.0 et OptionInteger en 1. Cliquez sur OK.
Dans le menu Outils, cliquez sur Importer et exporter les paramètres, sélectionnez Importer les paramètres de l’environnement sélectionnés, puis cliquez sur Suivant.
La page Enregistrer les paramètres actuels apparaît.
Sélectionnez Non, juste importer de nouveaux paramètres puis cliquez sur Suivant.
La page Choisir une collection de paramètres à importer apparaît.
Sélectionnez le fichier MySettings.vssettings dans le nœud Mes Paramètres de l’arborescence. Si le fichier n’apparaît pas dans l’arborescence, cliquez sur Parcourir et trouvez-le. Sélectionnez Suivant.
La boîte de dialogue Choisir les paramètres à importer apparaît.
Assurez-vous que Mes Paramètres est sélectionné, puis cliquez sur Terminer. Lorsque la page Importation complète apparaît, cliquez sur Fermer.
Dans le menu Outils, cliquez sur Options, développez Ma Catégorie, cliquez sur Ma Page de Grille et vérifiez que les valeurs de la catégorie de propriété ont été restaurées.