メニューコントローラーのツールバーへの追加 - Visual Studio (Windows)

[アーティクル]
01/12/2024

このチュートリアルは、「ツールウィンドウにツールバーを追加する」チュートリアルに基づいており、ツールウィンドウのツールバーにメニューコントローラーを追加する方法を示しています。ここに示す手順は、「ツールバーの追加」チュートリアルで作成したツールバーにも適用できます。

メニューコントローラーは分割コントロールです。メニューコントローラーの左側には最後に使用したコマンドが表示され、それをクリックすると実行できます。メニューコントローラーの右側は矢印です。これをクリックすると、追加のコマンドの一覧が表示されます。一覧でコマンドをクリックすると、コマンドが実行され、メニューコントローラーの左側のコマンドが置き換えられます。このようにして、メニューコントローラーは、一覧から最後に使用したコマンドを常に表示するコマンドボタンのように動作します。

メニューコントローラーはメニューに表示できますが、最も頻繁に使用されるのはツールバーです。

「ツールウィンドウにツールバーを追加する」で説明されている手順に従って、ツールバーを持つツールウィンドウを作成します。
TWTestCommandPackage.vsct で、Symbols セクションに移動します。 guidTWTestCommandPackageCmdSet という GuidSymbol 要素で、メニューコントローラー、メニューコントローラーグループ、3 つのメニュー項目を宣言します。
```
<IDSymbol name="TestMenuController" value="0x1300" /><IDSymbol name="TestMenuControllerGroup" value="0x1060" /><IDSymbol name="cmdidMCItem1" value="0x0130" /><IDSymbol name="cmdidMCItem2" value="0x0131" /><IDSymbol name="cmdidMCItem3" value="0x0132" />
```

[メニュー] セクションで、最後のメニューエントリの後にメニューコントローラーをメニューとして定義します。

<Menu guid="guidTWTestCommandPackageCmdSet" id="TestMenuController" priority="0x0100" type="MenuController">
    <Parent guid="guidTWTestCommandPackageCmdSet" id="TWToolbarGroup" />
    <CommandFlag>IconAndText</CommandFlag>
    <CommandFlag>TextChanges</CommandFlag>
    <CommandFlag>TextIsAnchorCommand</CommandFlag>
    <Strings>
        <ButtonText>Test Menu Controller</ButtonText>
        <CommandName>Test Menu Controller</CommandName>
    </Strings>
</Menu>

メニューコントローラーに最後に選択したコマンドを反映できるようにするには、TextChanges と TextIsAnchorCommand フラグを含める必要があります。

[グループ] セクションで、最後のグループエントリの後にメニューコントローラーグループを追加します。
```
<Group guid="guidTWTestCommandPackageCmdSet" id="TestMenuControllerGroup" priority="0x000">
    <Parent guid="guidTWTestCommandPackageCmdSet" id="TestMenuController" />
</Group>
```
メニューコントローラーを親として設定すると、このグループに配置されているすべてのコマンドがメニューコントローラーに表示されます。 priority 属性が省略されています。メニューコントローラー上の唯一のグループであるため、これにより既定値の 0 に設定されます。

[ボタン] セクションで、最後のボタンエントリの後に、各メニュー項目の Button 要素を追加します。

<Button guid="guidTWTestCommandPackageCmdSet" id="cmdidMCItem1" priority="0x0000" type="Button">
    <Parent guid="guidTWTestCommandPackageCmdSet" id="TestMenuControllerGroup" />
    <Icon guid="guidImages" id="bmpPic1" />
    <CommandFlag>IconAndText</CommandFlag>
    <Strings>
        <ButtonText>MC Item 1</ButtonText>
        <CommandName>MC Item 1</CommandName>
    </Strings>
</Button>
<Button guid="guidTWTestCommandPackageCmdSet" id="cmdidMCItem2" priority="0x0100" type="Button">
    <Parent guid="guidTWTestCommandPackageCmdSet" id="TestMenuControllerGroup" />
    <Icon guid="guidImages" id="bmpPic2" />
    <CommandFlag>IconAndText</CommandFlag>
    <Strings>
        <ButtonText>MC Item 2</ButtonText>
        <CommandName>MC Item 2</CommandName>
    </Strings>
</Button>
<Button guid="guidTWTestCommandPackageCmdSet" id="cmdidMCItem3" priority="0x0200" type="Button">
    <Parent guid="guidTWTestCommandPackageCmdSet" id="TestMenuControllerGroup" />
    <Icon guid="guidImages" id="bmpPicSearch" />
    <CommandFlag>IconAndText</CommandFlag>
    <Strings>
        <ButtonText>MC Item 3</ButtonText>
        <CommandName>MC Item 3</CommandName>
    </Strings>
</Button>

この時点で、メニューコントローラーを見ることができます。プロジェクトをビルドし、デバッグを開始します。実験用のインスタンスが表示されるはずです。
1. [表示] メニューの [その他のウィンドウ] で、[ToolWindow のテスト] を開きます。
2. ツールウィンドウのツールバーにメニューコントローラーが表示されます。
3. メニューコントローラーの右側にある矢印をクリックすると、使用可能な 3 つのコマンドが表示されます。
  
  コマンドをクリックすると、メニューコントローラーのタイトルが変更され、そのコマンドが表示されることに注意してください。次のセクションでは、これらのコマンドをアクティブにするコードを追加します。

TWTestCommandPackageGuids.cs で、既存のコマンド ID の後に 3 つのメニュー項目のコマンド ID を追加します。
```
public const int cmdidMCItem1 = 0x130;
public const int cmdidMCItem2 = 0x131;
public const int cmdidMCItem3 = 0x132;
```
TWTestCommand.cs で、TWTestCommand クラスの先頭に次のコードを追加します。
```
private int currentMCCommand; // The currently selected menu controller command
```

TWTestCommand コンストラクターで、AddCommand メソッドの最後の呼び出しの後に、同じハンドラーを使用して各コマンドのイベントをルーティングするコードを追加します。

for (int i = TWTestCommandPackageGuids.cmdidMCItem1; i <=
    TWTestCommandPackageGuids.cmdidMCItem3; i++)
{
    CommandID cmdID = new
    CommandID(new Guid(TWTestCommandPackageGuids.guidTWTestCommandPackageCmdSet), i);
    OleMenuCommand mc = new OleMenuCommand(new
      EventHandler(OnMCItemClicked), cmdID);
    mc.BeforeQueryStatus += new EventHandler(OnMCItemQueryStatus);
    commandService.AddCommand(mc);
    // The first item is, by default, checked. 
    if (TWTestCommandPackageGuids.cmdidMCItem1 == i)
    {
        mc.Checked = true;
        this.currentMCCommand = i;
    }
}

TWTestCommand クラスにイベントハンドラーを追加して、選択したコマンドをチェック対象としてマークします。

private void OnMCItemQueryStatus(object sender, EventArgs e)
{
    OleMenuCommand mc = sender as OleMenuCommand;
    if (null != mc)
    {
        mc.Checked = (mc.CommandID.ID == this.currentMCCommand);
    }
}

ユーザーがメニューコントローラーでコマンドを選択したときにメッセージボックスを表示するイベントハンドラーを追加します。

private void OnMCItemClicked(object sender, EventArgs e)
{
    OleMenuCommand mc = sender as OleMenuCommand;
    if (null != mc)
    {
        string selection;
        switch (mc.CommandID.ID)
        {
            case c.cmdidMCItem1:
                selection = "Menu controller Item 1";
                break;

            case TWTestCommandPackageGuids.cmdidMCItem2:
                selection = "Menu controller Item 2";
                break;

            case TWTestCommandPackageGuids.cmdidMCItem3:
                selection = "Menu controller Item 3";
                break;

            default:
                selection = "Unknown command";
                break;
        }
        this.currentMCCommand = mc.CommandID.ID;

        IVsUIShell uiShell =
          (IVsUIShell) ServiceProvider.GetService(typeof(SVsUIShell));
        Guid clsid = Guid.Empty;
        int result;
        uiShell.ShowMessageBox(
                0,
                ref clsid,
                "Test Tool Window Toolbar Package",
                string.Format(CultureInfo.CurrentCulture,
                             "You selected {0}", selection),
                string.Empty,
                0,
                OLEMSGBUTTON.OLEMSGBUTTON_OK,
                OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST,
                OLEMSGICON.OLEMSGICON_INFO,
                0,
                out result);
    }
}

プロジェクトをビルドし、デバッグを開始します。実験用のインスタンスが表示されるはずです。
[表示] メニューの [その他のウィンドウ] で、[ToolWindow のテスト] を開きます。

ツールウィンドウのツールバーにメニューコントローラーが表示され、[MC 項目 1] が表示されます。
矢印の左側にあるメニューコントローラーのボタンをクリックします。

3 つの項目が表示されます。最初の項目が選択されており、そのアイコンは強調表示ボックスで囲まれています。 [MC 項目 3] をクリックします。

ダイアログボックスが開き、「メニューコントローラー項目 3 を選択しました」というメッセージが表示されます。メッセージがメニューコントローラーボタンのテキストに対応することに注意してください。メニューコントローラーボタンに [MC 項目 3] が表示されるようになりました。

次の方法で共有

メニューコントローラーを作成する

メニューコントローラーのコマンドを実装する

メニューコントローラーのテスト

その他のリソース

次の方法で共有

ツール バーにメニュー コントローラーを追加する

メニュー コントローラーを作成する

メニュー コントローラーのコマンドを実装する

メニュー コントローラーのテスト

関連するコンテンツ

その他のリソース

ツールバーにメニューコントローラーを追加する

メニューコントローラーを作成する

メニューコントローラーのコマンドを実装する

メニューコントローラーのテスト