ツールウィンドウを追加する

[アーティクル]
03/10/2023

このチュートリアルでは、次の手順でツールウィンドウを作成し、Visual Studio に統合する方法について説明します。

ツールウィンドウにコントロールを追加します。
ツールウィンドウにツールバーを追加します。
ツールバーにコマンドを追加します。
コマンドを実装します。
ツールウィンドウの既定の位置を設定します。

前提条件

Visual Studio SDK は、Visual Studio セットアップのオプション機能です。詳細については、「Visual Studio SDK のインストール」を参照してください。

ツールウィンドウを作成する

VSIX テンプレートを使用して FirstToolWin という名前のプロジェクトを作成し、FirstToolWindow という名前のカスタムツールウィンドウ項目テンプレートを追加します。

Note

ツールウィンドウでの拡張機能の作成について詳しくは、「ツールウィンドウでの拡張機能の作成」をご覧ください。

ツールウィンドウにコントロールを追加する

既定のコントロールを削除します。 FirstToolWindowControl.xaml を開き、[Click Me!] ボタンを削除します。
ツールボックスで、[すべての WPF コントロール] セクションを展開し、[メディア要素] コントロールを FirstToolWindowControl フォームにドラッグします。コントロールを選択し、[プロパティ] ウィンドウで、この要素に mediaElement1 という名前を付けます。

次のようにツールバーを追加すると、そのグラデーションと色が IDE の他の部分と一致することが保証されます。

ソリューションエクスプローラーで、FirstToolWindowPackage.vsct を開きます。 .vsct ファイルでは、XML を使用して、ツールウィンドウ内のグラフィカルユーザーインターフェイス (GUI) 要素を定義します。
<Symbols> セクションで、name 属性が guidFirstToolWindowPackageCmdSet である <GuidSymbol> ノードを見つけます。ツールバーとツールバーグループを定義するには、このノードの <IDSymbol> 要素のリストに次の 2 つの <IDSymbol> 要素を追加します。
```
<IDSymbol name="ToolbarID" value="0x1000" />
<IDSymbol name="ToolbarGroupID" value="0x1001" />
```
<Buttons> セクションのすぐ上に、次のような <Menus> セクションを作成します。
```
<Menus>
    <Menu guid="guidFirstToolWindowPackageCmdSet" id="ToolbarID" priority="0x0000" type="ToolWindowToolbar">
        <Parent guid="guidFirstToolWindowPackageCmdSet" id="ToolbarID" />
        <Strings>
            <ButtonText>Tool Window Toolbar</ButtonText>
            <CommandName>Tool Window Toolbar</CommandName>
        </Strings>
    </Menu>
</Menus>
```
メニューにはいくつかの種類があります。このメニューはツールウィンドウ内のツールバーであり、属性 type によって定義されています。 guid と id の設定からツールバーの完全修飾 ID が構成されます。通常、メニューの <Parent> は、親グループです。ただし、ツールバーは自身の親として定義されます。したがって、<Menu> 要素と <Parent> 要素には同じ識別子が使用されます。 priority 属性は単に "0" です。
ツールバーは、さまざまな点でメニューに似ています。たとえば、メニューにコマンドのグループが含まれる場合があるのと同様に、ツールバーにもグループが含まれる場合があります。 (メニューでは、コマンドグループは横線で区切られます。ツールバーでは、グループは視覚的な区切り線で区切られていません)。

<Group> 要素を含む <Groups> セクションを追加します。これにより、<Symbols> セクションで宣言した ID を持つグループが定義されます。 <Menus> セクションの直後に <Groups> セクションを追加します。
```
<Groups>
    <Group guid="guidFirstToolWindowPackageCmdSet" id="ToolbarGroupID" priority="0x0000">
        <Parent guid="guidFirstToolWindowPackageCmdSet" id="ToolbarID" />
    </Group>
</Groups>
```
親の GUID と ID をツールバーの GUID と ID に設定すると、そのグループがツールバーに追加されます。

ツールバーにコマンドを追加します。これはボタンとして表示されます。

<Symbols> セクションで、ツールバーとツールバーグループの宣言の直後に、次の IDSymbol 要素を宣言します。
```
<IDSymbol name="cmdidWindowsMedia" value="0x0100" />
<IDSymbol name="cmdidWindowsMediaOpen" value="0x132" />
```

<Buttons> セクション内に Button 要素を追加します。この要素は、ツールウィンドウ内のツールバーに、検索 (虫眼鏡) アイコンで表示されます。

<Button guid="guidFirstToolWindowPackageCmdSet" id="cmdidWindowsMediaOpen" priority="0x0101" type="Button">
    <Parent guid="guidFirstToolWindowPackageCmdSet" id="ToolbarGroupID"/>
    <Icon guid="guidImages" id="bmpPicSearch" />
    <Strings>
        <CommandName>cmdidWindowsMediaOpen</CommandName>
        <ButtonText>Load File</ButtonText>
    </Strings>
</Button>

FirstToolWindowCommand.cs を開き、既存のフィールドの直後に次の行をクラスに追加します。

public const string guidFirstToolWindowPackageCmdSet = "00000000-0000-0000-0000-0000";  // get the GUID from the .vsct file
public const uint cmdidWindowsMedia = 0x100;
public const int cmdidWindowsMediaOpen = 0x132;
public const int ToolbarID = 0x1000;

これにより、コードでコマンドを使用できるようになります。

MediaPlayer プロパティを FirstToolWindowControl に追加する

コードでは、ツールバーコントロールのイベントハンドラーから、FirstToolWindowControl クラスの子である Media Player コントロールにアクセスできる必要があります。

ソリューションエクスプローラーで、FirstToolWindowControl.xaml を右クリックし、[コードの表示] をクリックして、FirstToolWindowControl クラスに次のコードを追加します。

public System.Windows.Controls.MediaElement MediaPlayer
{
    get { return mediaElement1; }
}

ツールバーを追加し、[ファイルを開く] ダイアログを起動して選択されたメディアファイルを再生するメニューコマンドを追加します。

FirstToolWindow.cs を開き、次の using ディレクティブを追加します。

using System.ComponentModel.Design;
using System.Windows.Forms;
using Microsoft.VisualStudio.Shell.Interop;

FirstToolWindow クラス内に、FirstToolWindowControl コントロールへのパブリック参照を追加します。
```
public FirstToolWindowControl control;
```
コンストラクターの末尾で、このコントロール変数を新しく作成したコントロールに設定します。
```
control = new FirstToolWindowControl();
base.Content = control;
```

コンストラクター内でツールバーをインスタンス化します。

this.ToolBar = new CommandID(new Guid(FirstToolWindowCommand.guidFirstToolWindowPackageCmdSet),
    FirstToolWindowCommand.ToolbarID);
this.ToolBarLocation = (int)VSTWT_LOCATION.VSTWT_TOP;

この時点で、FirstToolWindow コンストラクターは次のようになります。

public FirstToolWindow() : base(null)
{
    this.Caption = "FirstToolWindow";
    this.BitmapResourceID = 301;
    this.BitmapIndex = 1;
    control = new FirstToolWindowControl();
    base.Content = control;
    this.ToolBar = new CommandID(new Guid(FirstToolWindowCommand.guidFirstToolWindowPackageCmdSet),
        FirstToolWindowCommand.ToolbarID);
        this.ToolBarLocation = (int)VSTWT_LOCATION.VSTWT_TOP;
}

ツールバーにメニューコマンドを追加します。 FirstToolWindowCommand.cs クラスで、次の using ディレクティブを追加します。
```
using System.Windows.Forms;
```

FirstToolWindowCommand クラスで、ShowToolWindow() メソッドの末尾に次のコードを追加します。 ButtonHandler コマンドは、次のセクションで実装されます。

// Create the handles for the toolbar command.
var mcs = this.ServiceProvider.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
var toolbarbtnCmdID = new CommandID(new Guid(FirstToolWindowCommand.guidFirstToolWindowPackageCmdSet),
    FirstToolWindowCommand.cmdidWindowsMediaOpen);
var menuItem = new MenuCommand(new EventHandler(
    ButtonHandler), toolbarbtnCmdID);
mcs.AddCommand(menuItem);

FirstToolWindowCommand クラスに、[ファイルを開く] ダイアログを呼び出す ButtonHandler メソッドを追加します。ファイルが選択されると、メディアファイルが再生されます。
FirstToolWindowCommand クラスに、FindToolWindow() メソッドで作成される FirstToolWindow ウィンドウへのプライベート参照を追加します。
```
private FirstToolWindow window;
```

ShowToolWindow() メソッドを変更して、上で定義したウィンドウを設定します。これにより、ButtonHandler コマンドハンドラーがウィンドウコントロールにアクセスできるようになります。完全な ShowToolWindow() メソッドを次に示します。

private void ShowToolWindow(object sender, EventArgs e)
{
    window = (FirstToolWindow) this.package.FindToolWindow(typeof(FirstToolWindow), 0, true);
    if ((null == window) || (null == window.Frame))
    {
        throw new NotSupportedException("Cannot create tool window");
    }

    IVsWindowFrame windowFrame = (IVsWindowFrame)window.Frame;
    Microsoft.VisualStudio.ErrorHandler.ThrowOnFailure(windowFrame.Show());

    var mcs = this.ServiceProvider.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
    var toolbarbtnCmdID = new CommandID(new Guid(FirstToolWindowCommandguidFirstToolWindowPackageCmdSet),
        FirstToolWindowCommand.cmdidWindowsMediaOpen);
    var menuItem = new MenuCommand(new EventHandler(
        ButtonHandler), toolbarbtnCmdID);
    mcs.AddCommand(menuItem);
}

ButtonHandler メソッドを追加します。これは、ユーザーが再生するメディアファイルを指定するための OpenFileDialog を作成してから、選択されたファイルを再生します。

private void ButtonHandler(object sender, EventArgs arguments)
{
    OpenFileDialog openFileDialog = new OpenFileDialog();
    DialogResult result = openFileDialog.ShowDialog();
    if (result == DialogResult.OK)
    {
        window.control.MediaPlayer.Source = new System.Uri(openFileDialog.FileName);
    }
}

ツールウィンドウの既定の位置を設定する

次に、IDE でのツールウィンドウの既定位置を指定します。ツールウィンドウの構成情報は、FirstToolWindowPackage.cs ファイルにあります。

FirstToolWindowPackage.cs で、FirstToolWindowPackage クラスの ProvideToolWindowAttribute 属性を見つけます。これにより、 FirstToolWindow 型がコンストラクターに渡されます。既定の位置を指定するには、次の例のように、コンストラクターにさらにパラメーターを追加する必要があります。
```
[ProvideToolWindow(typeof(FirstToolWindow),
    Style = Microsoft.VisualStudio.Shell.VsDockStyle.Tabbed,
    Window = "3ae79031-e1bc-11d0-8f78-00a0c9110057")]
```
最初の名前付きパラメーターは Style で、その値は Tabbed です。これは、ウィンドウが既存のウィンドウのタブになることを意味します。ドッキング位置は、Window パラメーターによって指定されます。このケースでは、ソリューションエクスプローラーの GUID です。

Note

IDE のウィンドウの種類の詳細については、vsWindowType を参照してください。

ツールウィンドウをテストする

F5 キーを押して、Visual Studio 試験的ビルドの新しいインスタンスを開きます。
[表示] メニューの [その他のウィンドウ]をポイントし、[最初のツールウィンドウ] をクリックします。

メディアプレーヤーのツールウィンドウがソリューションエクスプローラーと同じ位置で開くはずです。まだ以前と同じ位置に表示される場合は、ウィンドウのレイアウトをリセットします ([ウィンドウ] / [ウィンドウレイアウトのリセット])。
ツールウィンドウで、ボタン (検索アイコンが表示されています) をクリックします。サポートされているサウンドファイルまたはビデオファイル (たとえば、C:\windows\media\chimes.wav) を選択し、[開く] を押します。

チャイム音が聞こえます。

コマンド、メニュー、およびツールバー

次の方法で共有

ツールウィンドウを追加する

前提条件

ツールウィンドウを作成する

ツールウィンドウにコントロールを追加する

MediaPlayer プロパティを FirstToolWindowControl に追加する

ツールウィンドウにメニューコマンドを実装するには

ツールウィンドウの既定の位置を設定する

ツールウィンドウをテストする

その他のリソース

次の方法で共有

ツール ウィンドウを追加する

前提条件

ツール ウィンドウを作成する

ツール ウィンドウにコントロールを追加する

ツール ウィンドウにツール バーを追加する

ツール バーにコマンドを追加する

MediaPlayer プロパティを FirstToolWindowControl に追加する

ツール ウィンドウとツールバーをインスタンス化する

ツール ウィンドウにメニュー コマンドを実装するには

ツール ウィンドウの既定の位置を設定する

ツール ウィンドウをテストする

関連するコンテンツ

その他のリソース

ツールウィンドウを追加する

ツールウィンドウを作成する

ツールウィンドウにコントロールを追加する

ツールウィンドウにツールバーを追加する

ツールバーにコマンドを追加する

ツールウィンドウとツールバーをインスタンス化する

ツールウィンドウにメニューコマンドを実装するには

ツールウィンドウの既定の位置を設定する

ツールウィンドウをテストする