动态添加菜单项

项目
01/12/2024

可以在运行时添加菜单项，方法是在 Visual Studio command-table （.vsct）文件中的占位符按钮定义上指定DynamicItemStart命令标志，然后定义（在代码中）显示和处理命令的菜单项数。加载 VSPackage 后，占位符将替换为动态菜单项。

Visual Studio 使用“最近使用”列表中的动态列表，其中显示最近打开的文档的名称，以及显示当前打开的窗口名称的 Windows 列表。命令 DynamicItemStart 定义上的标志指定命令是占位符，直到打开 VSPackage。打开 VSPackage 后，占位符将替换为在运行时创建的 0 个或多个命令，并将其添加到动态列表中。在打开 VSPackage 之前，可能无法在显示动态列表的菜单上看到位置。若要填充动态列表，Visual Studio 要求 VSPackage 查找 ID 的命令，其第一个字符与占位符的 ID 相同。当 Visual Studio 找到匹配的命令时，它会将命令的名称添加到动态列表中。然后，它会递增 ID 并查找要添加到动态列表的另一个匹配命令，直到没有其他动态命令。

本演练演示如何使用解决方案资源管理器工具栏上的命令在 Visual Studio 解决方案中设置启动项目。它使用具有活动解决方案中项目的动态下拉列表的菜单控制器。若要使此命令在未打开解决方案或打开的解决方案只有一个项目时显示，仅当解决方案具有多个项目时，才会加载 VSPackage。

有关 .vsct 文件的详细信息，请参阅 Visual Studio 命令表（.vsct）文件。

创建名为 DynamicMenuItems. 的 VSIX 项目。
项目打开时，添加自定义命令项模板并将其命名为 DynamicMenu。有关详细信息，请参阅使用菜单命令创建扩展。

设置 .vsct 文件中的元素

若要在工具栏上创建具有动态菜单项的菜单控制器，请指定以下元素：

两个命令组，一个包含菜单控制器，另一个包含下拉列表中的菜单项
一个类型菜单元素 MenuController
两个按钮，一个充当菜单项的占位符，另一个按钮提供工具栏上的图标和工具提示。

在 DynamicMenuPackage.vsct 中，定义命令 ID。转到“符号”部分，替换 guidDynamicMenuPackageCmdSet GuidSymbol 块中的 IDSymbol 元素。需要为两个组、菜单控制器、占位符命令和定位点命令定义 IDSymbol 元素。

<GuidSymbol name="guidDynamicMenuPackageCmdSet" value="{ your GUID here }">
    <IDSymbol name="MyToolbarItemGroup" value="0x1020" />
    <IDSymbol name="MyMenuControllerGroup" value="0x1025" />
    <IDSymbol name="MyMenuController" value ="0x1030"/>
    <IDSymbol name="cmdidMyAnchorCommand" value="0x0103" />
    <!-- NOTE: The following command expands at run time to some number of ids.
     Try not to place command ids after it (e.g. 0x0105, 0x0106).
     If you must add a command id after it, make the gap very large (e.g. 0x200) -->
    <IDSymbol name="cmdidMyDynamicStartCommand" value="0x0104" />
</GuidSymbol>

在“组”部分中，删除现有组，并添加刚刚定义的两个组：

<Groups>
    <!-- The group that adds the MenuController on the Solution Explorer toolbar.
         The 0x4000 priority adds this group after the group that contains the
         Preview Selected Items button, which is normally at the far right of the toolbar. -->
    <Group guid="guidDynamicMenuPackageCmdSet" id="MyToolbarItemGroup" priority="0x4000" >
        <Parent guid="guidSHLMainMenu" id="IDM_VS_TOOL_PROJWIN" />
    </Group>
    <!-- The group for the items on the MenuController drop-down. It is added to the MenuController submenu. -->
    <Group guid="guidDynamicMenuPackageCmdSet" id="MyMenuControllerGroup" priority="0x4000" >
        <Parent guid="guidDynamicMenuPackageCmdSet" id="MyMenuController" />
    </Group>
</Groups>

添加 MenuController。设置 DynamicVisibility 命令标志，因为它并不总是可见。不显示 ButtonText。

<Menus>
    <!-- The MenuController to display on the Solution Explorer toolbar.
         Place it in the ToolbarItemGroup.-->
    <Menu guid="guidDynamicMenuPackageCmdSet" id="MyMenuController" priority="0x1000" type="MenuController">
        <Parent guid="guidDynamicMenuPackageCmdSet" id="MyToolbarItemGroup" />
        <CommandFlag>DynamicVisibility</CommandFlag>
        <Strings>
           <ButtonText></ButtonText>
       </Strings>
    </Menu>
</Menus>

添加两个按钮，一个作为动态菜单项的占位符，一个作为 MenuController 的定位点。

占位符按钮的父级是 MyMenuControllerGroup。将 DynamicItemStart、DynamicVisibility 和 TextChanges 命令标志添加到占位符按钮。不显示 ButtonText。

定位点按钮保存图标和工具提示文本。定位点按钮的父级也是 MyMenuControllerGroup。添加 NoShowOnMenuController 命令标志，以确保该按钮实际上不会出现在菜单控制器下拉列表中，以及 FixMenuController 命令标志，使其成为永久定位点。

<!-- The placeholder for the dynamic items that expand to N items at run time. -->
<Buttons>
    <Button guid="guidDynamicMenuPackageCmdSet" id="cmdidMyDynamicStartCommand" priority="0x1000" >
      <Parent guid="guidDynamicMenuPackageCmdSet" id="MyMenuControllerGroup" />
      <CommandFlag>DynamicItemStart</CommandFlag>
      <CommandFlag>DynamicVisibility</CommandFlag>
      <CommandFlag>TextChanges</CommandFlag>
      <!-- This text does not appear. -->
      <Strings>
        <ButtonText>Project</ButtonText>
      </Strings>
    </Button>

    <!-- The anchor item to supply the icon/tooltip for the MenuController -->
    <Button guid="guidDynamicMenuPackageCmdSet" id="cmdidMyAnchorCommand" priority="0x0000" >
      <Parent guid="guidDynamicMenuPackageCmdSet" id="MyMenuControllerGroup" />
      <!-- This is the icon that appears on the Solution Explorer toolbar. -->
      <Icon guid="guidImages" id="bmpPicArrows"/>
      <!-- Do not show on the menu controller's drop down list-->
      <CommandFlag>NoShowOnMenuController</CommandFlag>
      <!-- Become the permanent anchor item for the menu controller -->
      <CommandFlag>FixMenuController</CommandFlag>
      <!-- The text that appears in the tooltip.-->
      <Strings>
        <ButtonText>Set Startup Project</ButtonText>
      </Strings>
    </Button>
</Buttons>

将图标添加到项目（在“资源”文件夹中），然后在 .vsct 文件中添加对它的引用。在本演练中，我们使用项目模板中包含的箭头图标。

在“符号”部分之前，在“命令”部分外添加 VisibilityConstraints 部分。（如果在符号之后添加警告，可能会收到警告。本部分确保仅当加载具有多个项目的解决方案时，菜单控制器才会显示。

<VisibilityConstraints>
     <!--Make the MenuController show up only when there is a solution with more than one project loaded-->
    <VisibilityItem guid="guidDynamicMenuPackageCmdSet" id="MyMenuController" context="UICONTEXT_SolutionHasMultipleProjects"/>
</VisibilityConstraints>

创建继承自 OleMenuCommand. 的动态菜单命令类。在此实现中，构造函数指定要用于匹配命令的谓词。必须重写 DynamicItemMatch 该方法以使用此谓词来设置属性 MatchedCommandId ，该属性标识要调用的命令。

创建名为 DynamicItemMenuCommand.cs 的新 C# 类文件，并添加一个名为 DynamicItemMenuCommand 的类，该类继承自 OleMenuCommand：
```
class DynamicItemMenuCommand : OleMenuCommand
{

}
```

添加以下 using 指令：

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

添加专用字段以存储匹配谓词：
```
private Predicate<int> matches;
```

添加从 OleMenuCommand 构造函数继承的构造函数，并指定命令处理程序和 BeforeQueryStatus 处理程序。添加用于匹配命令的谓词：

public DynamicItemMenuCommand(CommandID rootId, Predicate<int> matches, EventHandler invokeHandler, EventHandler beforeQueryStatusHandler)
    : base(invokeHandler, null /*changeHandler*/, beforeQueryStatusHandler, rootId)
{
    if (matches == null)
    {
        throw new ArgumentNullException("matches");
    }

    this.matches = matches;
}

DynamicItemMatch重写该方法，使其调用匹配谓词并设置MatchedCommandId属性：

public override bool DynamicItemMatch(int cmdId)
{
    // Call the supplied predicate to test whether the given cmdId is a match.
    // If it is, store the command id in MatchedCommandid
    // for use by any BeforeQueryStatus handlers, and then return that it is a match.
    // Otherwise clear any previously stored matched cmdId and return that it is not a match.
    if (this.matches(cmdId))
    {
        this.MatchedCommandId = cmdId;
        return true;
    }

    this.MatchedCommandId = 0;
    return false;
}

添加命令

DynamicMenu 构造函数是设置菜单命令的位置，包括动态菜单和菜单项。

在 DynamicMenuPackage.cs 中，添加命令集的 GUID 和命令 ID：

public const string guidDynamicMenuPackageCmdSet = "00000000-0000-0000-0000-00000000";  // get the GUID from the .vsct file
public const uint cmdidMyCommand = 0x104;

在 DynamicMenu.cs 文件中，添加以下 using 指令：

using EnvDTE;
using EnvDTE80;
using System.ComponentModel.Design;

在 DynamicMenu 类中，添加专用字段 dte2。
```
private DTE2 dte2;
```
添加专用 rootItemId 字段：
```
private int rootItemId = 0;
```

在 DynamicMenu 构造函数中，添加菜单命令。在下一部分中，我们将定义命令处理程序、 BeforeQueryStatus 事件处理程序和匹配谓词。

private DynamicMenu(Package package)
{
    if (package == null)
    {
        throw new ArgumentNullException(nameof(package));
    }

    this.package = package;

    OleMenuCommandService commandService = this.ServiceProvider.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
    if (commandService != null)
    {
        // Add the DynamicItemMenuCommand for the expansion of the root item into N items at run time.
        CommandID dynamicItemRootId = new CommandID(
            new Guid(DynamicMenuPackageGuids.guidDynamicMenuPackageCmdSet),
            (int)DynamicMenuPackageGuids.cmdidMyCommand);
        DynamicItemMenuCommand dynamicMenuCommand = new DynamicItemMenuCommand(
            dynamicItemRootId,
            IsValidDynamicItem,
            OnInvokedDynamicItem,
            OnBeforeQueryStatusDynamicItem);
            commandService.AddCommand(dynamicMenuCommand);
    }

    this.dte2 = (DTE2)this.ServiceProvider.GetService(typeof(DTE));
}

实现处理程序

若要在菜单控制器上实现动态菜单项，必须在单击动态项时处理该命令。还必须实现设置菜单项状态的逻辑。将处理程序添加到 DynamicMenu 类。

若要实现 “设置启动项目” 命令，请添加 OnInvokedDynamicItem 事件处理程序。它查找名称与已调用的命令的文本相同的项目，并通过在属性中 StartupProjects 设置其绝对路径将其设置为启动项目。

private void OnInvokedDynamicItem(object sender, EventArgs args)
{
    DynamicItemMenuCommand invokedCommand = (DynamicItemMenuCommand)sender;
    // If the command is already checked, we don't need to do anything
    if (invokedCommand.Checked)
        return;

    // Find the project that corresponds to the command text and set it as the startup project
    var projects = dte2.Solution.Projects;
    foreach (Project proj in projects)
    {
        if (invokedCommand.Text.Equals(proj.Name))
        {
            dte2.Solution.SolutionBuild.StartupProjects = proj.FullName;
            return;
        }
    }
}

OnBeforeQueryStatusDynamicItem添加事件处理程序。这是在事件之前调用的 QueryStatus 处理程序。它确定菜单项是否为“real”项，即占位符项，以及该项是否已检查（这意味着项目已设置为启动项目）。

private void OnBeforeQueryStatusDynamicItem(object sender, EventArgs args)
{
    DynamicItemMenuCommand matchedCommand = (DynamicItemMenuCommand)sender;
    matchedCommand.Enabled = true;
    matchedCommand.Visible = true;

    // Find out whether the command ID is 0, which is the ID of the root item.
    // If it is the root item, it matches the constructed DynamicItemMenuCommand,
     // and IsValidDynamicItem won't be called.
    bool isRootItem = (matchedCommand.MatchedCommandId == 0);

    // The index is set to 1 rather than 0 because the Solution.Projects collection is 1-based.
    int indexForDisplay = (isRootItem ? 1 : (matchedCommand.MatchedCommandId - (int) DynamicMenuPackageGuids.cmdidMyCommand) + 1);

    matchedCommand.Text = dte2.Solution.Projects.Item(indexForDisplay).Name;

    Array startupProjects = (Array)dte2.Solution.SolutionBuild.StartupProjects;
    string startupProject = System.IO.Path.GetFileNameWithoutExtension((string)startupProjects.GetValue(0));

    // Check the command if it isn't checked already selected
    matchedCommand.Checked = (matchedCommand.Text == startupProject);

    // Clear the ID because we are done with this item.
    matchedCommand.MatchedCommandId = 0;
}

实现命令 ID 匹配谓词

现在实现匹配谓词。我们需要确定两件事：首先，命令 ID 是否有效（它大于或等于声明的命令 ID），其次，它是否指定一个可能的项目（它小于解决方案中的项目数）。

private bool IsValidDynamicItem(int commandId)
{
    // The match is valid if the command ID is >= the id of our root dynamic start item
    // and the command ID minus the ID of our root dynamic start item
    // is less than or equal to the number of projects in the solution.
    return (commandId >= (int)DynamicMenuPackageGuids.cmdidMyCommand) && ((commandId - (int)DynamicMenuPackageGuids.cmdidMyCommand) < dte2.Solution.Projects.Count);
}

仅当解决方案具有多个项目时，才将 VSPackage 设置为加载

由于“设置启动项目”命令没有意义，除非活动解决方案具有多个项目，因此只能在这种情况中将 VSPackage 设置为自动加载。与 UI 上下文SolutionHasMultipleProjects一ProvideAutoLoadAttribute起使用。在 DynamicMenuPackage.cs 文件中，将以下属性添加到 DynamicMenuPackage 类：

[PackageRegistration(UseManagedResourcesOnly = true)]
[InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)]
[ProvideMenuResource("Menus.ctmenu", 1)]
[ProvideAutoLoad(UIContextGuids.SolutionHasMultipleProjects)]
[Guid(DynamicMenuPackage.PackageGuidString)]
public sealed class DynamicMenuItemsPackage : Package
{}

测试设置启动项目命令

现在可以测试代码。

生成项目并启动调试。应显示实验实例。
在实验实例中，打开具有多个项目的解决方案。

应会在解决方案资源管理器工具栏上看到箭头图标。展开它时，应显示表示解决方案中不同项目的菜单项。
检查其中一个项目时，它将成为启动项目。
关闭解决方案或打开只有一个项目的解决方案时，工具栏图标应消失。

通过

使用菜单命令创建扩展

设置 .vsct 文件中的元素

实现动态菜单命令

添加命令

实现处理程序

实现命令 ID 匹配谓词

仅当解决方案具有多个项目时，才将 VSPackage 设置为加载

测试设置启动项目命令

其他资源

通过

动态添加菜单项

使用菜单命令创建扩展

设置 .vsct 文件中的元素

实现动态菜单命令

添加命令

实现处理程序

实现命令 ID 匹配谓词

仅当解决方案具有多个项目时，才将 VSPackage 设置为加载

测试设置启动项目命令

相关内容

其他资源