Prise en charge pour les paramètres utilisateurSupport for User Settings

Un VSPackage peut définir une ou plusieurs catégories de paramètres, qui sont des groupes de variables d’état qui demeurent lorsqu’un utilisateur choisit le paramètres d’importation/exportation commande sur le outils menu.A VSPackage may define one or more settings categories, which are groups of state variables that persist when a user chooses the Import/Export Settings command on the Tools menu. Pour activer cette persistance, vous utilisez les paramètres API dans le Kit de développement logiciel Visual StudioVisual Studio SDK.To enable this persistence, you use the settings APIs in the Kit de développement logiciel Visual StudioVisual Studio SDK.

Une entrée de Registre est désigné comme un Point de paramètres personnalisés et un GUID définit la catégorie de paramètres d’un VSPackage.A registry entry that is referred to as a Custom Settings Point and a GUID defines a VSPackage's settings category. Un VSPackage peut prendre en charge plusieurs catégories de paramètres, chacun définis par un Point de paramètres personnalisés.A VSPackage can support multiple settings categories, each defined by a Custom Settings Point.

  • Les implémentations de paramètres qui sont basées sur les assemblys d’interopérabilité (à l’aide de la IVsUserSettings interface) doit créer le Point de paramètres personnalisés en modifiant le Registre ou à l’aide d’un script de Registre (fichier .rgs).Implementations of settings that are based on interop assemblies (using the IVsUserSettings interface) should create Custom Settings Point by either editing the registry or using a Registrar script (.rgs file). Pour plus d’informations, consultez création de Scripts de bureau d’enregistrement.For more information, see Creating Registrar Scripts.

  • Le code qui utilise Managed Package Framework (MPF) doit-elle créer des Points de paramètres personnalisés en associant un ProvideProfileAttribute pour le VSPackage pour chaque Point de paramètres personnalisés.Code that uses the Managed Package Framework (MPF) should create Custom Settings Points by attaching a ProvideProfileAttribute to the VSPackage for each Custom Settings Point.

    Si un VSPackage unique 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 chacun est enregistré par une instance unique de la ProvideProfileAttribute classe.If a single VSPackage supports several Custom Settings Points, each Custom Settings Point is implemented by a separate class, and each is registered by a unique instance of the ProvideProfileAttribute class. Par conséquent, une classe d’implémentation de paramètres peuvent prendre en charge plusieurs catégories de paramètres.Consequently, a settings implementing class can support more than one settings category.

Détails de l’entrée des paramètres personnalisés du Registre de PointCustom Settings Point Registry Entry Details

Points de paramètres personnalisés sont créés dans une entrée de Registre à l’emplacement suivant : HKLM\Software\Microsoft\VisualStudio\<Version >\UserSettings\<CSPName>, où <CSPName> est le nom du Point de paramètres personnalisés le prend en charge VSPackage et <Version > est la version de Visual StudioVisual Studio, par exemple 8.0.Custom Settings Points are created in a registry entry in the following location: HKLM\Software\Microsoft\VisualStudio\<Version>\UserSettings\<CSPName>, where <CSPName> is the name of the Custom Settings Point the VSPackage supports and <Version> is the version of Visual StudioVisual Studio, for example 8.0.

Note

Le chemin d’accès racine de HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\<Version > peut être remplacée par une autre racine lorsque le Visual StudioVisual Studio est de l’environnement de développement intégré (IDE) initialisé.The root path of HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\<Version> can be overridden with an alternate root when the Visual StudioVisual Studio integrated development environment (IDE) is initialized. Pour plus d’informations, consultez les commutateurs de ligne de commande.For more information, see Command-Line Switches.

La structure de l’entrée de Registre est illustrée ci-dessous :The structure of the registry entry is illustrated below:

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

<CSPName> = s '#12345'<CSPName>= s '#12345'

Package = '{XXXXXX XXXX XXXX XXXX XXXXXXXXX}'Package = '{XXXXXX XXXX XXXX XXXX XXXXXXXXX}'

Catégorie = '{AAAAAA aaaa jj aaaa YYYYYYYYY}'Category = '{YYYYYY YYYY YYYY YYYY YYYYYYYYY}'

ResourcePackage = '{ZZZZZZ ZZZZ ZZZZ ZZZZ ZZZZZZZZZ}'ResourcePackage = '{ZZZZZZ ZZZZ ZZZZ ZZZZ ZZZZZZZZZ}'

AlternateParent = nom de catégorieAlternateParent = CategoryName

NameName TypeType DonnéesData DescriptionDescription
(Default)(Default) REG_SZREG_SZ Nom du Point de paramètres personnalisésName of the Custom Settings Point Nom de la clé, <CSPName>, est le nom non localisé du Point de paramètres personnalisés.The key's name, <CSPName>, is the unlocalized name of the Custom Settings Point.

Pour les implémentations basées sur MPF, son nom est obtenu en combinant les categoryName et objectName arguments de la ProvideProfileAttribute constructeur dans categoryName_objectName.For implementations based on MPF, the key's name is obtained by combining the categoryName and objectName arguments of the ProvideProfileAttribute constructor into categoryName_objectName.

La clé peut être vide ou il peut contenir l’ID de référence à la chaîne localisée dans une DLL satellite.The key can be empty, or it can contain the reference ID to the localized string in a satellite DLL. Cette valeur est obtenue à partir de la objectNameResourceID l’argument de la ProvideProfileAttribute constructeur.This value is obtained from the objectNameResourceID argument to the ProvideProfileAttribute constructor.
PackagePackage REG_SZREG_SZ GUIDGUID Le GUID du VSPackage qui implémente le Point de paramètres personnalisés.The GUID of the VSPackage that implements the Custom Settings Point.

Implémentations basés sur MPF à l’aide de la ProvideProfileAttribute de classe, utilisez le constructeur objectType argument contenant le package Visual Studio Type et de la réflexion pour obtenir cette valeur.Implementations based on MPF using the ProvideProfileAttribute class, use the constructor's objectType argument containing the VSPackage's Type and reflection to obtain this value.
CategoryCategory REG_SZREG_SZ GUIDGUID GUID qui identifie la catégorie de paramètres.GUID identifying the settings category.

Pour les implémentations basées sur les assemblys PIA, cette valeur peut être arbitrairement choisis GUID, qui le Visual StudioVisual Studio IDE passe à la ExportSettings et ImportSettings méthodes.For implementations based on interop assemblies, this value can be an arbitrarily chosen GUID, which the Visual StudioVisual Studio IDE passes to the ExportSettings and the ImportSettings methods. Toutes les implémentations de ces deux méthodes doivent vérifier leurs arguments GUID.All implementations of these two methods should verify their GUID arguments.

Pour les implémentations basées sur MPF, ce GUID est obtenu par la Type de la classe implémentant le Visual StudioVisual Studio mécanisme de paramètres.For implementations based on MPF, this GUID is obtained by the Type of the class implementing the Visual StudioVisual Studio settings mechanism.
ResourcePackageResourcePackage REG_SZREG_SZ GUIDGUID Facultatif.Optional.

Chemin d’accès au satellite DLL contenant des chaînes localisées si l’implémentation VSPackage ne fournit pas les.Path to satellite DLL containing localized strings if the implementing VSPackage does not supply them.

MPF utilise la réflexion pour obtenir la bonne ressource VSPackage, donc la ProvideProfileAttribute classe ne définit pas cet argument.MPF uses reflection to obtain the correct resource VSPackage, so the ProvideProfileAttribute class does not set this argument.
AlternateParentAlternateParent REG_SZREG_SZ Nom du dossier dans la page Outils/Options contenant ce Point de paramètres personnalisés.Name of the folder under the Tools Options page containing this Custom Settings Point. Facultatif.Optional.

Vous devez définir cette valeur uniquement si une implémentation de paramètres prend en charge Outils Options des pages qui utilisent le mécanisme de persistance dans le Kit de développement logiciel Visual StudioVisual Studio SDK plutôt que le mécanisme dans le modèle automation pour enregistrer l’état.You must set this value only if a settings implementation supports Tools Options pages that use the persistence mechanism in the Kit de développement logiciel Visual StudioVisual Studio SDK rather than the mechanism in the automation model to save state.

Dans ces cas, la valeur de la clé AlternateParent est la topic section de la topic.sub-topic chaîne utilisée pour identifier le notamment OutilsOptions page.In these cases, the value in the AlternateParent key is the topic section of the topic.sub-topic string used to identify the particular ToolsOptions page. Par exemple, pour le OutilsOptions page "TextEditor.Basic" la valeur de AlternateParent serait "TextEditor".For example, for the ToolsOptions page "TextEditor.Basic" the value of AlternateParent would be "TextEditor".

Lorsque ProvideProfileAttribute génère le Point de paramètres personnalisés, il est le même que le nom de catégorie.When ProvideProfileAttribute generates the Custom Settings Point, it is the same as the category name.