ProvideToolboxItemsAttribute 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.11.40262

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 aux classes implémentant des VSPackages pour déclarer si elles offrent un ensemble d’éléments à la boîte à outils Visual Studio.

public ref class ProvideToolboxItemsAttribute : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)]
public class ProvideToolboxItemsAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)>]
type ProvideToolboxItemsAttribute = class
    inherit RegistrationAttribute

Public Class ProvideToolboxItemsAttribute
Inherits RegistrationAttribute

Héritage: Attribute

RegistrationAttribute
ProvideToolboxItemsAttribute

Attributs: AttributeUsageAttribute

Exemples

Dans l’exemple ci-dessous, les attributs appliqués à la classe MyPackage indiquent qu’elle prend en charge la version 1 des éléments de boîte à outils de avec deux formats de Presse-papiers « CF_XMLCODE » et « InPlaceMenuEditorMenu ».

[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]  
[ProvideToolboxItems(true, 1)]  
[ProvideToolboxFormat("CF_XMLCODE")]  
[ProvideToolboxFormat("InPlaceMenuEditorMenu")]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
internal sealed class MyPackage : Package

Remarques

Contexte d'attribut


S’applique à	Classes fournissant des VSPackages en implémentant IVsPackage, Package.
Renouvelable	No
Attributs requis	ProvideToolboxFormatAttribute
Attributs non valides	None

Appliquez cet attribut à une Packageclasse dérivée ou à une classe qui implémente IVsPackage qui est nécessaire pour permettre aux utilisateurs de faire glisser des objets de données de ce format, fournis par la classe, vers la boîte à outils. Cette classe d’implémentation doit gérer elle-même les notifications de suppression.

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

Selon les arguments spécifiés dans son constructeur, cet attribut peut indiquer qu’un VSPackage ne fournit aucun élément de boîte à outils . Si l’attribut ProvideToolboxFormatAttribute est ajouté à une classe pour indiquer qu’il fournit des éléments de boîte à outils , une ou plusieurs instances de ProvideToolboxFormatAttribute doivent également être ajoutées.

Cet attribut utilise ProvideToolboxFormatAttribute pour inscrire un VSPackage comme fournissant des éléments de boîte à outils d’un format donné.

Si cet attribut spécifie que des éléments de boîte à outils sont fournis, le VSPackage doit gérer les ToolboxInitialized événements et ToolboxUpgraded .

Tout VSPackage utilisant cet attribut doit fournir un gestionnaire pour les ToolboxInitialized événements et ToolboxUpgraded .

Constructeurs

ProvideToolboxItemsAttribute(Int32)	Crée un instance de ProvideToolboxItemsAttribute qui indique si une classe implémentant un VSPackage fournit des éléments de boîte à outils.
ProvideToolboxItemsAttribute(Int32, Boolean)	Initialise une nouvelle instance de ProvideToolboxItemsAttribute pour la version spécifiée.

Propriétés

NeedsCallBackAfterReset	La définition de cette valeur sur true force un événement ToolboxInitialized après chaque réinitialisation de la boîte à outils. Cela peut être utilisé lors du développement de votre package pour forcer la boîte à outils à demander la liste des éléments au package à chaque fois (au cas où il a changé). Pour les produits expédiés, il est préférable de laisser la valeur false afin que le cache puisse être utilisé pour de meilleures performances. Certains scénarios (par exemple, la liste d’éléments qui ne peut pas être conservée dans le cache) peuvent avoir besoin d’avoir cet indicateur défini sur true
TypeId	Remplacez la propriété TypeID pour permettre aux classes dérivées RegistrationAttribute de fonctionner avec System.ComponentModel.TypeDescriptor.GetAttributes(...). Un attribut dérivé de celui-ci ne doit remplacer cette propriété que s’il a besoin d’un meilleur contrôle sur les instances qui peuvent être appliquées à une classe. (Hérité de RegistrationAttribute)
Version	Propriété retournant la version des éléments de boîte à outils qu’un VSPackage fournit.

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 un VSPackage en tant que fournisseur d’éléments de boîte à outils pour les formats spécifiés lorsqu’il est appelé par un outil d’inscription externe tel que regpkg.exe. Pour plus d’informations, consultez Inscription de VSPackages.
Unregister(RegistrationAttribute+RegistrationContext)	Inverse les modifications que la méthode Register(RegistrationAttribute+RegistrationContext) a appliqué au Registre.

S’applique à

Partager via