最近使用した一覧のサブメニューへの追加

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

このチュートリアルは、「メニューにサブメニューを追加する」のデモを基にしており、サブメニューに動的リストを追加する方法を示しています。動的リストは、最近使用した (MRU) リストを作成するための基礎となります。

動的メニューリストは、メニューのプレースホルダーから始まります。メニューが表示されるたびに、Visual Studio 統合開発環境 (IDE) によって、プレースホルダーに表示されるすべてのコマンドが VSPackage に要求されます。動的リストは、メニュー上の任意の場所で実行できます。ただし、動的リストは通常、サブメニューやメニューの下部に格納されてそれだけで表示されます。これらの設計パターンを使用すると、メニュー上の他のコマンドの位置に影響を与えずに、コマンドの動的リストを拡張およびコントラクトすることができます。このチュートリアルでは、既存のサブメニューの一番下に動的 MRU リストが表示されます。これは、サブメニューの残りの部分から、線によって区切られています。

技術的には、動的リストをツールバーに適用することもできます。ただし、ユーザーが特定の手順を実行して変更しない限りは、ツールバーは変更されないようにするべきなので、その使用方法はお勧めしません。

このチュートリアルでは、4 つの項目のいずれかが選択されるたびに順序が変更される MRU リストを作成します (選択した項目が一覧の一番上に移動します)。

メニューおよび .vsct ファイルの詳細については、「コマンド、メニュー、およびツールバー」を参照してください。

前提条件

このチュートリアルを行うには、Visual Studio SDK をインストールする必要があります。詳細については、「Visual Studio SDK」を参照してください。

拡張機能を作成する

「メニューにサブメニューを追加する」の手順に従って、次の手順で変更されるサブメニューを作成します。

このチュートリアルの手順では、VSPackage の名前が TestCommand であることを前提としています。これは、「Visual Studio のメニューバーにメニューを追加する」で使用される名前です。

動的項目リストコマンドの作成

TestCommandPackage.vsct を開きます。
Symbols セクションの、guidTestCommandPackageCmdSet という名前の GuidSymbol ノードで MRUListGroup グループと cmdidMRUList コマンドのシンボルを次のように追加します。
```
<IDSymbol name="MRUListGroup" value="0x1200"/>
<IDSymbol name="cmdidMRUList" value="0x0200"/>
```

Groups セクションで、宣言されたグループを既存のグループエントリの後に追加します。

<Group guid="guidTestCommandPackageCmdSet" id="MRUListGroup"
        priority="0x0100">
    <Parent guid="guidTestCommandPackageCmdSet" id="SubMenu"/>
</Group>

Buttons セクションで、新しく宣言されたコマンドを表すノードを既存のボタンエントリの後に追加します。

<Button guid="guidTestCommandPackageCmdSet" id="cmdidMRUList"
    type="Button" priority="0x0100">
    <Parent guid="guidTestCommandPackageCmdSet" id="MRUListGroup" />
    <CommandFlag>DynamicItemStart</CommandFlag>
    <Strings>
        <CommandName>cmdidMRUList</CommandName>
        <ButtonText>MRU Placeholder</ButtonText>
    </Strings>
</Button>

DynamicItemStart フラグを使用すると、コマンドを動的に生成できます。

プロジェクトをビルドし、デバッグを開始して、新しいコマンドの表示をテストします。

[TestMenu] メニューの新しいサブメニュー [SubMenu] をクリックして、新しいコマンド MRU Placeholder を表示します。次の手順で動的 MRU のコマンドリストが実装されたら、サブメニューが開かれるたびに、このコマンドラベルがそのリストに置き換えられます。

MRU リストの入力

TestCommandPackageGuids.cs で、TestCommandPackageGuids クラス定義の既存のコマンド ID の後に次の行を追加します。

public const string guidTestCommandPackageCmdSet = "00000000-0000-0000-0000-00000000"; // get the GUID from the .vsct file
public const uint cmdidMRUList = 0x200;

TestCommand.cs に、次の using ステートメントを追加します。
```
using System.Collections;
```
最後の AddCommand 呼び出しの後に、TestCommand コンストラクターに次のコードを追加します。 InitMRUMenu は後で定義されます
```
this.InitMRUMenu(commandService);
```

TestCommand クラスに次のコードを追加します。このコードにより、MRU リストに表示される項目を表す文字列のリストが初期化されます。

private int numMRUItems = 4;
private int baseMRUID = (int)TestCommandPackageGuids.cmdidMRUList;
private ArrayList mruList;

private void InitializeMRUList()
{
    if (null == this.mruList)
    {
        this.mruList = new ArrayList();
        if (null != this.mruList)
        {
            for (int i = 0; i < this.numMRUItems; i++)
            {
                this.mruList.Add(string.Format(CultureInfo.CurrentCulture,
                    "Item {0}", i + 1));
            }
        }
    }
}

InitializeMRUList メソッドの後に、InitMRUMenu メソッドを追加します。これにより、MRU リストメニューコマンドが初期化されます。
```
private void InitMRUMenu(OleMenuCommandService mcs)
{
    InitializeMRUList();
    for (int i = 0; i < this.numMRUItems; i++)
    {
        var cmdID = new CommandID(
            new Guid(TestCommandPackageGuids.guidTestCommandPackageCmdSet), this.baseMRUID + i);
        var mc = new OleMenuCommand(
            new EventHandler(OnMRUExec), cmdID);
        mc.BeforeQueryStatus += new EventHandler(OnMRUQueryStatus);
        mcs.AddCommand(mc);
    }
}
```
MRU リストに表示されるすべての項目に対して、メニューコマンドオブジェクトを作成する必要があります。 IDE により、項目がなくなるまで、MRU リストの各項目に対して OnMRUQueryStatus メソッドが呼び出されます。マネージドコードでは、これ以上項目がないことが IDE により確認される唯一の方法は、可能なすべての項目を最初に作成することです。必要に応じて、メニューコマンドが作成された後で mc.Visible = false; を使用して、追加の項目を当初非表示にすることができます。これらの項目は、後で OnMRUQueryStatus メソッドで mc.Visible = true; を使用して表示できます。

InitMRUMenu メソッドの後に次の OnMRUQueryStatus メソッドを追加します。これは、各 MRU 項目のテキストを設定するハンドラーです。

private void OnMRUQueryStatus(object sender, EventArgs e)
{
    OleMenuCommand menuCommand = sender as OleMenuCommand;
    if (null != menuCommand)
    {
        int MRUItemIndex = menuCommand.CommandID.ID - this.baseMRUID;
        if (MRUItemIndex >= 0 && MRUItemIndex < this.mruList.Count)
        {
            menuCommand.Text = this.mruList[MRUItemIndex] as string;
        }
    }
}

OnMRUQueryStatus メソッドの後に次の OnMRUExec メソッドを追加します。これは、MRU 項目を選択するためのハンドラーです。このメソッドは、選択した項目をリストの一番上に移動し、選択した項目をメッセージボックスに表示します。

private void OnMRUExec(object sender, EventArgs e)
{
    var menuCommand = sender as OleMenuCommand;
    if (null != menuCommand)
    {
        int MRUItemIndex = menuCommand.CommandID.ID - this.baseMRUID;
        if (MRUItemIndex >= 0 && MRUItemIndex < this.mruList.Count)
        {
            string selection = this.mruList[MRUItemIndex] as string;
            for (int i = MRUItemIndex; i > 0; i--)
            {
                this.mruList[i] = this.mruList[i - 1];
            }
            this.mruList[0] = selection;
            System.Windows.Forms.MessageBox.Show(
                string.Format(CultureInfo.CurrentCulture,
                              "Selected {0}", selection));
        }
    }
}

MRU リストのテスト

プロジェクトをビルドし、デバッグを開始します。
[テストメニュー] メニューの [TestCommand の呼び出し] をクリックします。この操作を実行すると、コマンドが選択されたことを示すメッセージボックスが表示されます。

Note

この手順は、VSPackage に MRU リストを読み込んで正しく表示するために必要です。この手順を省略した場合、MRU リストは表示されません。
[テストメニュー] メニューの [サブメニュー] をクリックします。サブメニューの末尾、区切りの下に 4 つの項目の一覧が表示されます。 [項目 3] をクリックすると、メッセージボックスが表示され、「項目 3 を選択」というテキストが表示されます。 (4 つの項目の一覧が表示されない場合は、前の手順の指示に従っていることを確認してください)。
もう一度サブメニューを開きます。 [項目 3] がリストの一番上にあり、他の項目が 1 つ下に移動されていることを確認します。もう一度 [項目 3] をクリックすると、メッセージボックスにはまだ「項目 3 を選択」が表示されます。これは、テキストがコマンドラベルと共に新しい位置に正しく移動したことを示しています。

メニュー項目の動的な追加

最近使用した一覧のサブメニューへの追加

前提条件

拡張機能を作成する

動的項目リスト コマンドの作成

MRU リストの入力

MRU リストのテスト

関連するコンテンツ

その他のリソース

動的項目リストコマンドの作成