ProvideToolWindowAttribute Klasse

Referenz

Definition

Namespace:: Microsoft.VisualStudio.Shell

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

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

Paket:: Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Benachrichtigt Visual Studio, dass ein VSPackage ein Toolfenster besitzt.

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

Vererbung: Attribute

RegistrationAttribute
ProvideToolWindowAttribute

Attribute: AttributeUsageAttribute

Hinweise

Wann sollte ich anrufen?

Implementieren Sie die ProvideToolWindowAttribute -Klasse, wenn ein VSPackage ein oder mehrere Toolfenster implementiert.

Grundlegende Verwendung

Dieses Attribut deklariert, dass ein bestimmtes VSPackage ein Toolfenster besitzt. Es hilft auch, die Positionierung und Persistenz des Toolfensters zu bestimmen, wenn es erstellt wird. Um zu verwendenProvideToolWindowAttribute, platzieren Sie sie in einer Paketklasse, die von abgeleitet oder implementiert IVsPackagewirdPackage.

Dieses Attribut wird nur verwendet, um Daten für externe Registrierungstools bereitzustellen. Es hat keine Auswirkungen auf das Laufzeitverhalten des VSPackage.

Registrierungseinträge

Die ProvideToolWindowAttribute -Klasse erstellt die folgenden Registrierungseinträge:
<VSROOT>\ToolWindows\{ToolWindowGuid}
<VSROOT>\ToolWindows\{ToolWindowGuid}\@={ToolWindowTypeGuid}
<VSROOT>\ToolWindows\{ToolWindowGuid}\Name=ToolWindowName
Die folgenden Registrierungseinträge sind optional:
<VSROOT>\ToolWindows\{ToolWindowGuid}\Float=FloatPosition
<VSROOT>\ToolWindows\{ToolWindowGuid}\Style=ToolWindowStyle
<VSROOT>\ToolWindows\{ToolWindowGuid}\Window=DockWith
<VSROOT>\ToolWindows\{ToolWindowGuid}\Orientation=ToolWindowOrientation

Konstruktoren

ProvideToolWindowAttribute(Type)

Initialisiert eine neue Instanz von ProvideToolWindowAttribute.

Eigenschaften

AutoHidden	Legen Sie auf true fest, um das Toolfenster standardmäßig auszublenden.
DockedHeight	Ruft erz ab, wenn die Standardhöhe des ToolWindows festgelegt wird, wenn er angedockt wird.
DockedWidth	Ruft erz ab, legt die Standardbreite des ToolWindow fest, wenn es angedockt ist.
DocumentLikeTool	Legen Sie diese Eigenschaft auf true fest, wenn Sie ein Toolfenster wünschen, das im Verhalten und in der Lebensdauer einem Dokument ähnelt. Das Toolfenster ist nur MDI oder floating und bleibt in seiner Position über alle Layoutänderungen sichtbar, bis es manuell vom Benutzer geschlossen wird, an dem es zerstört wird. Dieses Flag impliziert DontForceCreate und destruktive multi-instance.
Height	Ruft die Standardhöhe des Toolfensters ab oder legt diese fest.
MultiInstances	Bestimmt, ob mehrere Instanzen des Toolfensters zugelassen werden.
Orientation	Ruft die Standardausrichtung des Toolfensters auf oder legt diese fest im Verhältnis zum Fenster, welches durch die Window-Eigenschaft festgelegt ist.
PositionX	Ruft den Standardhorizontalwert der oberen linken Ecke des Toolfensters auf oder legt diesen fest.
PositionY	Ruft den vertikalen Wert der oberen linken Ecke eines Toolfensters ab oder legt diesen fest.
Style	Ruft den standardmäßigen Andockstil für das Toolfenster auf oder legt diesen fest.
ToolType	Ruft den Typ des Toolfensters ab oder legt diesen fest.
Transient	Ruft ab oder legt fest, ob das Toolfenster nicht erneut geöffnet wird, wenn die IDE erneut startet.
TypeId	Überschreiben Sie die TypeID-Eigenschaft, damit die von RegistrationAttribute abgeleiteten Klassen mit System.ComponentModel.TypeDescriptor.GetAttributes(...) arbeiten können. Ein von diesem abgeleitetes Attribut muss diese Eigenschaft nur überschreiben, wenn es ein besseres Steuerelement für die Instanzen benötigt, die auf eine Klasse angewendet werden können. (Geerbt von RegistrationAttribute)
Width	Ruft die Standardbreite des Toolfensters ab oder legt diese fest.
Window	Ruft den GUID für das Standardfenster ab oder legt diesen fest, an welches das Toolfenster angedockt werden sollte.

Methoden

GetPackageRegKeyPath(Guid)	Ruft den Registrierungspfad (relativ zum Registrierungsstamm der Anwendung) des VSPackages ab. (Geerbt von RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Registriert das Toolfenster.
Unregister(RegistrationAttribute+RegistrationContext)	Entfernt den Registrierungsschlüssel für das Toolfenster.

Gilt für:

Freigeben über