ProvideOptionPageAttribute Classe

Référence

Définition

Espace de noms:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Paquet:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Appliquez cet attribut à des objets indépendants pour permettre aux utilisateurs de configurer des VSPackages via une page d’options d’outils personnalisée.

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideOptionPageAttribute : Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideOptionPageAttribute = class
    inherit ProvideOptionDialogPageAttribute

Public NotInheritable Class ProvideOptionPageAttribute
Inherits ProvideOptionDialogPageAttribute

Héritage: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Attributs: AttributeUsageAttribute

Exemples

Dans l’exemple ci-dessous, une instance de ProvideOptionPageAttribute est appliquée à une implémentation VSPackage pour inscrire la classe DesignerOptionsPage, qui est dérivée de DialogPage, en fournissant au VSPackage une page Options d’outils.

Les classes dérivées de DialogPage sont fournies avec une implémentation par défaut de la fonctionnalité de paramètres Visual Studio, qui peut être remplacée. L’IDE utilise cette prise en charge des paramètres Visual Studio si, comme dans l’exemple, ProvideProfileAttribute est appliqué à l’implémentation VSPackage. Pour plus d’informations sur la prise en charge des paramètres Visual Studio, consultez Extension des paramètres et options utilisateur.

using Microsoft.VisualStudio.Shell;  
namespace Example  
{  
[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]   
[ProvideOptionPage(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1000, 1001, true)]   
[ProvideProfileAttribute(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1002, 1003, true)]  
[ProvideProfileAttribute(typeof(PersistCurrentDesign), "MyDesigner","CurrentDesign", 1004, 1005, false)]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
public class MyPackage : Package  
{  
//Implementation here  
}  

[Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")]  
internal class DesignerOptionsPage: DialogPage {  
//Implementation here  
}  

[Guid("ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ")]  
internal class PersistCurrentDesign: IProfileManager {  
//Implementation here  
}

Remarques

Remarques pour les implémenteurs

Appliquez aux ProvideOptionPageAttribute classes implémentant un VSPackage. Cet attribut permet d’enregistrer qu’un objet indépendant spécifique fournit aux utilisateurs du VSPackage un accès à la configuration via une page d’options d’outils personnalisée.

Contexte d'attribut


S’applique à	Les VSPackages autorisent la configuration via des pages d’options d’outils personnalisées implémentées par le biais de Managed Package Framework ou à l’aide du code du DialogPage Kit de développement logiciel (SDK) Visual Studio.
Renouvelable	Yes
Attributs requis	DefaultRegistryRootAttribute
Attributs non valides	None

Remarques pour les appelants

Cet attribut est utilisé uniquement à des fins d’inscription et n’affecte pas le comportement d’exécution du code.

Inscrit ProvideOptionPageAttribute une classe donnée qui implémente IProfileManager ou DialogPage fournit une prise en charge particulière de VSPackage pour la persistance d’une partie ou de la totalité de l’état de VSPackage via le mécanisme de paramètres Visual Studio. Les informations d’état conservées par la classe d’implémentation sont appelées catégorie de paramètres Visual Studio et son entrée de définition dans le Registre est appelée point de paramètres personnalisés.

Notes

Lorsqu’une page Options d’outils personnalisées basées sur Managed Package Framework est chargée, l’IDE instancie l’objet inscrit par ProvideOptionPageAttribute en tant qu’implémentation. La prise en charge des options de la page Outils d’infrastructure de package managé doit être implémentée sur son propre objet et non sur le VSPackage lui-même.

Pour plus d’informations sur la création et l’application d’instances de ProvideOptionPageAttribute, consultez l’exemple ci-dessous et ProvideOptionPageAttribute.

Constructeurs

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Instancie une nouvelle instance de ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Instancie une nouvelle instance de ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Instancie une nouvelle instance de ProvideOptionPageAttribute.

Propriétés

CategoryDescriptionResourceId	ID d’une ressource contenant la description localisée de la catégorie parente de la page. Cette propriété est utilisée uniquement si SupportsAutomation == true et SupportsProfiles == true. La description localisée s’affiche dans l’Assistant Paramètres d’importation/exportation.
CategoryName	Obtient le nom canonique non localisé de la catégorie de la page Options d’outils.
CategoryPackageGuid	ID du package qui possède la catégorie sous laquelle cette page est inscrite. Si ce n’est pas défini, le package est supposé être celui auquel cet attribut est appliqué. Cette propriété est utilisée uniquement si SupportsAutomation == true et SupportsProfiles == true. Générez-le à partir d’un GUID avec Guid.ToString(« B »).
CategoryResourceID	Obtient l’ID de ressource de catégorie pour une page Options d’outils.
DescriptionResourceId	ID d’une ressource contenant la description localisée de la page. Cette propriété est utilisée uniquement si SupportsAutomation == true et SupportsProfiles == true. La description localisée s’affiche dans l’Assistant Paramètres d’importation/exportation.
IsInUnifiedSettings	Obtient ou définit une valeur indiquant si les paramètres de cette page ont été intégrés aux paramètres unifiés lors de la création d’une inscription. Si la valeur est true, la page est masquée lorsque les paramètres unifiés sont activés, de sorte que ses paramètres ne sont pas dupliqués.
IsServerAware	Obtient ou définit une valeur indiquant si l’interface utilisateur de cette page affiche les paramètres qui sont synchronisés avec le serveur dans un scénario client-serveur connecté à l’aide d’ISettingsManager3 ou d’une API avec des fonctionnalités similaires.
Keywords	Obtient les mots clés pouvant faire l’objet d’une recherche pour cette page d’options. Chaque mot clé peut être une chaîne littérale, un id/nom de ressource (préfixé par « @"/"# ») pointant vers un mot clé unique, ou un nom/ID de ressource (préfixé par « @"/"# ») pointant vers une liste de mots clés délimitées par des points-virgules.
NoShowAllView	Obtient ou définit si les pages d’options d’outils agrégées sont affichées.
PageName	Obtient le nom canonique non localisé de la page Options des outils.
PageNameResourceId	Obtient l'ID de ressource de nom de la page. (Hérité de ProvideOptionDialogPageAttribute)
PageType	Obtient le type de la page. (Hérité de ProvideOptionDialogPageAttribute)
ProfileMigrationType	Définit le type de migration du profil.
ProvidesLocalizedCategoryName	Détermine si le package a les ressources localisées pour le nom de catégorie.
Sort	Ordre de tri de la page d’options. Les pages d’options sont rassemblées dans l’ordre suivant : `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Obtient si l’implémentation d’une page Options Outils prend en charge l’automatisation.
SupportsProfiles	Obtient ou définit si une implémentation de page Options outils utilise le mécanisme de paramètres Visual Studio pour conserver son état.
TypeId	Obtient l'instance actuelle de ProvideOptionPageAttribute.
UnifiedSettingsCategoryMoniker	Pour les pages avec IsInUnifiedSettings = false, obtient ou définit le moniker de la catégorie parente dans la hiérarchie Des paramètres unifiés. Il peut s’agir d’un moniker qui existe déjà, ou d’un autre qui existe plus un « ». -segment délimité. Si ce dernier est le cas, une nouvelle catégorie nommée par CategoryResourceID est créée dans la hiérarchie Unified Settings et cette page y est insérée. Sinon, cette page est insérée sous la catégorie existante.
VisibilityCmdUIContexts	Liste délimitée par des points-virgules de GUID UIContext. La page d’options est visible quand un UIContext dans la liste est actif. Si ce n’est pas spécifié, la page d’options est toujours visible.

Méthodes

GetPackageRegKeyPath(Guid)	Obtient le chemin d'accès au Registre (relatif à la racine de Registre de l'application) du VSPackage. (Hérité de RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Inscrit la page Options des outils.
Unregister(RegistrationAttribute+RegistrationContext)	Supprime la clé de page Options d’outils du Registre.

S’applique à

Partager via