Partager via


Rendre des paramètres

Un VSPackage peut définir une ou plusieurs catégories de paramètres, qui sont des groupes de variables d'état qui sont persistantes lorsqu'un utilisateur sélectionne la commande de paramètres d'importation/exportation dans le menu d' Outils . Pour activer cette persistance, vous utilisez les API de paramètres dans Kit de développement logiciel Visual Studio.

Une entrée du Registre qui est indiquée comme un point de paramètres personnalisés et un GUID définit la catégorie des paramètres d'un VSPackage. Un VSPackage peut prendre en charge plusieurs catégories de paramètres, chacune définie par un point de paramètres personnalisés.

  • Les implémentations des paramètres basés sur les assemblys d'interopérabilité (à l'aide de l'interface d' IVsUserSettings ) doivent créer le point de paramètres personnalisés en modifiant le Registre soit à l'aide d'un script d'inscription (fichier .rgs). Pour plus d'informations, consultez Créer des scripts d'inscription.

  • Le code qui utilise managed package (MPF) doit créer des points de paramètres personnalisés en joignant ProvideProfileAttribute au VSPackage pour chaque point de paramètres personnalisés.

    Si un VSPackage seul prend en charge plusieurs points de paramètres personnalisés, chaque point de paramètres personnalisés est implémentée par une classe distincte, et est stocké par une instance unique de la classe d' ProvideProfileAttribute . Par conséquent, les paramètres de l'implémentation de la classe peuvent prendre en charge plusieurs catégorie de paramètres.

détails d'entrée du Registre de point de paramètres personnalisés

Les points de paramètres personnalisés sont créés dans une entrée du Registre à l'emplacement suivant : \Software\Microsoft\VisualStudio HKLM \ <Version> \UserSettings \<CSPName>, où <CSPName> est le nom des paramètres personnalisés pointent les prises en charge et <Version> d'un VSPackage sont la version de Visual Studio, par exemple 8,0.

Notes

Le chemin d'accès racine HKEY_LOCAL_MACHINE \SOFTWARE\Microsoft\VisualStudio \ <Version> peut être substitué par une autre racine lorsque l'environnement de développement intégré (IDE) de Visual Studio (IDE) est initialisé.Pour plus d'informations, consultez Commutateurs de la ligne de commande (Kit de développement logiciel Visual Studio).

La structure de l'entrée de Registre est illustrée ci-dessous :

\Software\Microsoft\VisualStudio HKLM \ <Version> \UserSettings \

      <CSPName>= s « #12345 »

            package = « {} »

            Catégorie = « {YYYYYY AAAA AAAA AAAA YYYYYYYYY} »

            ResourcePackage = « {ZZZZZZ ZZZZ ZZZZ ZZZZ ZZZZZZZZZ} »

            AlternateParent = CategoryName

Nom

Type

Données

Description

(Valeur par défaut)

REG_SZ

nom du point de paramètres personnalisés

Le nom de clé, <CSPName>, est le nom localisé du point de paramètres personnalisés.

Pour les implémentations en fonction MPF, le nom de clé est obtenu en combinant les arguments d' categoryName et d' objectName du constructeur d' ProvideProfileAttribute dans categoryName_objectName.

La clé peut être vide, ou elle peut contenir l'ID de référence à la chaîne localisée dans une DLL satellite. cette valeur est obtenue à partir de l'argument d' objectNameResourceID au constructeur d' ProvideProfileAttribute .

Package

REG_SZ

GUID

GUID du VSPackage qui implémente le point de paramètres personnalisés.

Les implémentations en fonction MPF à l'aide de la classe d' ProvideProfileAttribute , utilisez l'argument d' objectType du constructeur contenant Type et la réflexion du VSPackage pour obtenir cette valeur.

Catégorie

REG_SZ

GUID

GUID identifiant la catégorie de paramètres.

Pour les implémentations en fonction de les assemblys d'interopérabilité, cette valeur peut être un GUID arbitrairement choisi, que Visual Studio IDE passe à l' ExportSettings et aux méthodes d' ImportSettings . Toutes les implémentations de ces deux méthodes doivent vérifier leurs arguments GUID.

Pour les implémentations en fonction MPF, ce GUID est obtenu par Type de la classe implémentant le mécanisme de paramètres de Visual Studio .

ResourcePackage

REG_SZ

GUID

Facultatif.

Chemin d'accès à la DLL satellite contenant des chaînes localisées si le VSPackage implémentant les ne fournit pas.

MPF utilise la réflexion pour obtenir la ressource appropriée VSPackage, donc la classe d' ProvideProfileAttribute ne définit pas cet argument.

AlternateParent

REG_SZ

Nom du dossier sous la page d'options Outils contenant ce point de paramètres personnalisés.

Facultatif.

Vous devez définir cette valeur uniquement si une implémentation de paramètres prend en charge les pages d' options d'outils qui utilisent le mécanisme de persistance dans Kit de développement logiciel Visual Studio plutôt que le mécanisme dans le modèle Automation de pour enregistrer l'état. Pour plus d'informations, consultez Stocker les pages options personnalisées.

Dans ces cas, la valeur de la clé d'AlternateParent est la section d' topic de la chaîne d' topic.sub-topic utilisée pour identifier la page d'options particulière d' Outils. Par exemple, la page d'options "TextEditor.Basic" d' Outilsla valeur d'AlternateParent serait"TextEditor".

Lorsque ProvideProfileAttribute génère le point de paramètres personnalisés, il s'agit du même que le nom de la catégorie.

Voir aussi

Tâches

Comment : Exporter des paramètres à l'aide de les assemblys d'interopérabilité

Comment : Assemblys d'interopérabilité d'utilisation pour importer des paramètres

Référence

Créer des scripts d'inscription

ProvideProfileAttribute

Créer des scripts d'inscription

Concepts

Utilisation des pages options

Rendre des paramètres

Autres ressources

persistance d'état et l'IDE de Visual Studio

Working with Settings