ProvideToolWindowAttribute Classe

Définition

Espace de noms:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Paquet:

Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Avertit Visual Studio qu’un VSPackage possède une fenêtre d’outil.

public ref class ProvideToolWindowAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

public ref class ProvideToolWindowAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute

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

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

Public NotInheritable Class ProvideToolWindowAttribute
Inherits RegistrationAttribute

Héritage

Attribute

RegistrationAttribute

ProvideToolWindowAttribute

Attributs

AttributeUsageAttribute

Remarques

Quand appeler

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

Utilisation de base

Cet attribut déclare qu’un VSPackage spécifique possède une fenêtre outil. Il permet également de déterminer le positionnement et la persistance de la fenêtre outil lors de sa création. Pour utiliser ProvideToolWindowAttribute, placez-le sur une classe de package dérivée de Package ou implémentant IVsPackage.

Cet attribut est utilisé uniquement pour fournir des données pour les outils d’inscription externes. Elle n’a aucun effet sur le comportement d’exécution du VSPackage.

Entrées de Registre

• La ProvideToolWindowAttribute classe crée les entrées de Registre suivantes :

• <VSROOT>\ToolWindows\{ToolWindowGuid}

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

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

• Les entrées de Registre suivantes sont facultatives :

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

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

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

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

Constructeurs

ProvideToolWindowAttribute(Type)

Initialise une nouvelle instance de ProvideToolWindowAttribute.

Propriétés

AutoHidden	Définissez sur true pour masquer la fenêtre outil par défaut.
DockedHeight	Obtient le minerai définit la hauteur par défaut de ToolWindow lorsqu’il est ancré.
DockedWidth	Obtient le minerai définit la largeur par défaut de ToolWindow lorsqu’il est ancré.
DocumentLikeTool	Définissez cette propriété sur true si vous souhaitez une fenêtre outil semblable à un document dans son comportement et sa durée de vie. La fenêtre outil sera uniquement MDI ou flottante et restera visible dans sa position sur toutes les modifications de disposition jusqu’à ce que l’utilisateur la ferme manuellement. Cet indicateur implique DontForceCreate et plusieurs instance destructeurs.
Height	Obtient ou définit la hauteur par défaut de la fenêtre Outil.
MultiInstances	Détermine si plusieurs instances de la fenêtre Outil sont autorisées.
Orientation	Obtient ou définit l'orientation par défaut de la fenêtre Outil par rapport à la fenêtre spécifiée par la propriété de la fenêtre.
PositionX	Obtient ou définit la valeur horizontale par défaut de l'angle supérieur gauche de la fenêtre Outil.
PositionY	Obtient ou définit la valeur verticale de l'angle supérieur gauche de la fenêtre Outil.
Style	Obtient ou définit le style d'ancrage par défaut de la fenêtre Outil.
ToolType	Définit ou obtient le type de la fenêtre Outil.
Transient	Obtient ou définit une valeur indiquant si la fenêtre Outil doit être rouverte au redémarrage de l'IDE.
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)
Width	Obtient ou définit la largeur par défaut de la fenêtre Outil.
Window	Obtient et définit le GUID de la fenêtre par défaut sur laquelle la fenêtre Outil doit être ancrée.

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 fenêtre Outil.
Unregister(RegistrationAttribute+RegistrationContext)	Supprime la clé de Registre de la fenêtre Outil.