ProvideToolWindowAttribute, classe

Informe Visual Studio qu'un VSPackage possède une fenêtre Outil.

Hiérarchie d'héritage

System.Object
  System.Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideToolWindowAttribute

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, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class ProvideToolWindowAttribute _
    Inherits RegistrationAttribute

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

Le type ProvideToolWindowAttribute expose les membres suivants.

Constructeurs

	Nom	Description
	ProvideToolWindowAttribute	Initialise une nouvelle instance d'ProvideToolWindowAttribute.

Début

Propriétés

	Nom	Description
	DockedHeight
	DockedWidth
	DocumentLikeTool
	Height	Obtient ou définit la hauteur par défaut de la fenêtre Outil.
	MultiInstances	Détermine si les instances multiples de la fenêtre Outil.
	Orientation	Obtient ou définit l'orientation par défaut pour la fenêtre Outil par rapport à la fenêtre spécifiée par la propriété de fenêtre.
	PositionX	Obtient ou définit la valeur horizontale par défaut du coin supérieur gauche de la fenêtre Outil.
	PositionY	Obtient ou définit la valeur verticale du coin supérieur gauche de la fenêtre Outil.
	Style	Obtient ou définit le style par défaut d'ancrage pour la fenêtre Outil.
	ToolType	Obtient ou définit le type de la fenêtre Outil.
	Transient	Obtient ou définit si la fenêtre Outil ne doit pas être rouverte lorsque les redémarrages d'IDE.
	TypeId	Obtient l'instance actuel de cet attribut. (Hérité de RegistrationAttribute.)
	Width	Obtient ou définit la largeur par défaut de la fenêtre Outil.
	Window	Obtient ou définit GUID de la fenêtre par défaut sur laquelle la fenêtre Outil doit être accueillie.

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.)
	GetPackageRegKeyPath	Obtient le chemin d'accès au Registre (par rapport à la racine de Registre de l'application) du VSPackage. (Hérité de RegistrationAttribute.)
	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.)
	Register	Enregistre la fenêtre Outil. (Substitue RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
	Unregister	Supprime la clé de Registre pour la fenêtre Outil. (Substitue RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

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

Lorsque appeler

Implémentez la classe d'ProvideToolWindowAttribute lorsqu'un VSPackage implémente une ou plusieurs fenêtres Outil.

Utilisation de base

Cet attribut déclare qu'un VSPackage spécifique possède une fenêtre Outil.Elle aide également à déterminer positionner et la persistance de la fenêtre Outil lorsqu'elle est créée.Pour utiliser ProvideToolWindowAttribute, placez- sur une classe dérivée de package d'Package ou implémentante IVsPackage.

Cet attribut est seulement utilisé pour fournir des données pour les outils externes d'alignement.Il n'a aucun effet sur le comportement d'exécution du VSPackage.

Entrées du Registre

• La classe d'ProvideToolWindowAttribute crée les entrées du Registre suivantes :

• <VSROOT>\ToolWindows\{ToolWindowGuid}

• <VSROOT>\ToolWindows\{ToolWindowGuid}\@={ToolWindowTypeGuid}

• <VSROOT>\ToolWindows\{ToolWindowGuid}\Name=ToolWindowName

• Les entrées du Registre suivantes sont facultatives :

• <VSROOT>\ToolWindows\{ToolWindowGuid}\Float=FloatPosition

• <VSROOT>\ToolWindows\{ToolWindowGuid}\Style=ToolWindowStyle

• <VSROOT>\ToolWindows\{ToolWindowGuid}\Window=DockWith

• <VSROOT>\ToolWindows\{ToolWindowGuid}\Orientation=ToolWindowOrientation

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