ProvideToolWindowAttribute クラス

定義

名前空間:

Microsoft.VisualStudio.Shell

アセンブリ:

Microsoft.VisualStudio.Shell.15.0.dll

パッケージ:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

VSPackage がツール ウィンドウを所有していることを Visual Studio に通知します。

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

継承

Attribute

RegistrationAttribute

ProvideToolWindowAttribute

属性

AttributeUsageAttribute

注釈

呼び出すタイミング

VSPackage で 1 つ以上の ProvideToolWindowAttribute ツール ウィンドウが実装されている場合は、 クラスを実装します。

基本的な使用方法

この属性は、特定の VSPackage がツール ウィンドウを所有していることを宣言します。 また、作成時のツール ウィンドウの位置と永続化を判断するのにも役立ちます。 を使用 ProvideToolWindowAttributeするには、 から Package 派生したパッケージ クラスまたは を実装する IVsPackageパッケージ クラスに配置します。

この属性は、外部登録ツールのデータを提供するためにのみ使用されます。 VSPackage のランタイム動作には影響しません。

レジストリ エントリ

• クラスは ProvideToolWindowAttribute 、次のレジストリ エントリを作成します。

• <VSROOT>\ToolWindows\{ToolWindowGuid}

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

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

• 次のレジストリ エントリは省略可能です。

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

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

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

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

コンストラクター

ProvideToolWindowAttribute(Type)

ProvideToolWindowAttribute の新しいインスタンスを初期化します。

プロパティ

AutoHidden	既定でツール ウィンドウを非表示にするには、true に設定します。
DockedHeight	ドッキング時の ToolWindow の既定の高さを取得します。
DockedWidth	ドッキング時の ToolWindow の既定の幅を取得します。
DocumentLikeTool	動作と有効期間でドキュメントのようなツール ウィンドウが必要な場合は、このプロパティを true に設定します。 ツール ウィンドウは MDI またはフローティングのみになり、破棄される時点でユーザーが手動で閉じるまで、すべてのレイアウト変更にわたってその位置に表示されます。 このフラグは、DontForceCreate および破壊的マルチ インスタンスを意味します。
Height	ツール ウィンドウの既定の高さを取得または設定します。
MultiInstances	ツール ウィンドウの複数のインスタンスを許可するかどうかを決定します。
Orientation	Window プロパティで指定されたウィンドウに対するツール ウィンドウの既定の向きを取得または設定します。
PositionX	ツール ウィンドウの左上隅の既定の水平方向の値を取得または設定します。
PositionY	ツール ウィンドウの左上隅の垂直方向の値を取得または設定します。
Style	ツール ウィンドウの既定のドッキング スタイルを取得または設定します。
ToolType	ツール ウィンドウの種類を取得または設定します。
Transient	IDE の再起動時にツール ウィンドウを再度開かないようにするかどうかを取得または設定します。
TypeId	RegistrationAttribute 派生クラスが System.ComponentModel.TypeDescriptor.GetAttributes(...) と連携できるように、TypeID プロパティをオーバーライドします。このプロパティから派生した属性は、クラスに適用できるインスタンスをより適切に制御する必要がある場合にのみ、このプロパティをオーバーライドする必要があります。 (継承元 RegistrationAttribute)
Width	ツール ウィンドウの既定の幅を取得または設定します。
Window	ツール ウィンドウをドッキングする既定のウィンドウの GUID を取得または設定します。

メソッド

GetPackageRegKeyPath(Guid)	VSPackage のレジストリ パス (アプリケーションのレジストリ ルートに対する相対パス) を取得します。 (継承元 RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	ツール ウィンドウを登録します。
Unregister(RegistrationAttribute+RegistrationContext)	ツール ウィンドウのレジストリ キーを削除します。