ProvideToolboxFormatAttribute, classe

Appliquez-vous cet attribut aux classes implémentant des VSPackages pour déclarer que le VSPackage fournit à des éléments de boîte à outils le format de presse-papiers spécifié et pour activer la prise en charge glissée-déplacée dans Visual Studioboîte à outils.

Hiérarchie d'héritage

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.ProvideToolboxFormatAttribute

Espace de noms :  Microsoft.VisualStudio.Shell
Assembly :  Microsoft.VisualStudio.Shell.11.0 (dans Microsoft.VisualStudio.Shell.11.0.dll)

Syntaxe

'Déclaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := True, AllowMultiple := True)> _
Public NotInheritable Class ProvideToolboxFormatAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public sealed class ProvideToolboxFormatAttribute : Attribute

Le type ProvideToolboxFormatAttribute expose les membres suivants.

Constructeurs

	Nom	Description
	ProvideToolboxFormatAttribute	Initialise une nouvelle instance d'ProvideToolboxFormatAttribute pour le format spécifié.

Début

Propriétés

	Nom	Description
	Format	Obtient le nom d'un format de presse-papiers pris en charge.
	TypeId	Lors de son implémentation dans une classe dérivée, obtient un identificateur unique pour Attribute. (Hérité de Attribute.)

Début

Méthodes

	Nom	Description
	Equals	Infrastructure. Retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	GetHashCode	Retourne le code de hachage de cette instance. (Hérité de Attribute.)
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	IsDefaultAttribute	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée. (Hérité de Attribute.)
	Match	En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié. (Hérité de Attribute.)
	MemberwiseClone	Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Implémentations d'interface explicite

	Nom	Description
	_Attribute.GetIDsOfNames	Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute.)
	_Attribute.GetTypeInfo	Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface. (Hérité de Attribute.)
	_Attribute.GetTypeInfoCount	Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute.)
	_Attribute.Invoke	Fournit l'accès aux propriétés et aux méthodes exposées par un objet. (Hérité de Attribute.)

Début

Remarques

Contexte d'attribut

S'applique à	Les classes fournissant des VSPackages en implémentant IVsPackage interface ou l'interface d'Package.
Reproductible	Oui
Attributs requis	ProvideToolboxItemsAttribute
Attributs valides	Aucun

Cet attribut est utilisé uniquement pour l'alignement et n'affecte pas le comportement d'exécution.

Appliquez-vous cet attribut aux classes implémentant un VSPackage que fournit à des éléments de boîte à outils un format de presse-papiers non standard ou ne prend en charge pas un ou plusieurs les formats de presse-papiers par défaut de boîte à outils.

Un VSPackage sans cet attribut doit prendre en charge tous les types de presse-papiers de boîte à outils de valeur par défaut.

Pour une liste des types de presse-papiers de boîte à outils de valeur par défaut pris en charge par un VSPackage, consultez Boîte à outils (kit de développement Visual Studio SDK).

L'utilisation de cet attribut par lui-même n'enregistre pas un VSPackage comme fournisseur des éléments avec un presse-papiers donné.Une instance de l'attribut doit être appliquée pour enregistrer le VSPackage comme fournissant des objets du format spécifié.

Un seul format de presse-papiers est enregistré comme pris en charge pour chaque instance de cet attribut appliqué à une classe.Pour indiquer que de plusieurs formats sont pris en charge, plusieurs instances de l'attribut doivent être appliquées à la classe.

Le C- de Remarque ajoute automatiquement le mot « attribut » au nom de toute classe d'attributs.Dans le code C-, reportez -vous à cet attribut comme ProvideToolboxFormat.

Exemples

Dans l'exemple ci-dessous des attributs appliqués à la classe de MyPackage indique qu'elle prend en charge la version 1 des éléments de boîte à outils 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

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.Shell, espace de noms

ProvideToolboxFormatAttribute

Autres ressources

Boîte à outils (kit de développement Visual Studio SDK)