4.6在工具窗口中添加快捷菜单

在工具窗口中添加快捷菜单

Visual Studio 2015

其他版本



 

若要了解有关 Visual Studio 2017 RC 的最新文档，请参阅 Visual Studio 2017 RC 文档。

本演练中放入一个工具窗口的快捷菜单。 快捷菜单，用户单击鼠标右键按钮、 文本框中或窗口背景时，将显示一个菜单。 在快捷菜单上的命令的行为与其他菜单或工具栏上的命令相同。 若要支持的快捷菜单，在.vsct 文件中指定它，并将其显示在响应鼠标右键单击。

工具窗口包含的自定义工具窗口类中继承自一个 WPF 用户控件ToolWindowPane。

本演练演示如何通过声明.vsct 文件中的菜单项，然后使用管理包框架在定义工具窗口中的类中实现它们作为 Visual Studio 菜单中，创建一个快捷菜单。 此方法方便了对 Visual Studio 命令、 用户界面元素和自动化对象模型的访问。

或者，如果您的快捷菜单将不能访问 Visual Studio 功能，您可以使用ContextMenu用户控件中的 XAML
元素的属性。 有关详细信息，请参阅ContextMenu。

先决条件



启动 Visual Studio 2015 中，您并不安装 Visual Studio SDK 从下载中心获得。 它将包括作为 Visual Studio 安装程序中的可选功能。 您还可以在以后安装 VS SDK。 有关详细信息，请参阅安装
Visual Studio SDK。

创建工具窗口快捷方式菜单程序包



创建一个名为的 VSIX 项目

TWShortcutMenu

并添加一个名为的工具窗口模板快捷菜单给它。
有关创建工具窗口的详细信息，请参阅使用一个工具窗口创建扩展。

指定的快捷菜单



快捷菜单，如在本演练中所示使用户可以从用来填充工具窗口的背景的颜色的列表中选择。

在 ShortcutMenuPackage.vsct，在名为 guidShortcutMenuPackageCmdSet，GuidSymbol 元素中查找并声明快捷菜单、 快捷方式菜单组和菜单选项。 GuidSymbol 元素现在应如下所示︰

XML

<GuidSymbol name="guidShortcutMenuPackageCmdSet" value="{00000000-0000-0000-0000-0000}"> // your GUID here
<IDSymbol name="ShortcutMenuCommandId" value="0x0100" />
<IDSymbol name="ColorMenu" value="0x1000"/>
<IDSymbol name="ColorGroup" value="0x1100"/>
<IDSymbol name="cmdidRed" value="0x102"/>
<IDSymbol name="cmdidYellow" value="0x103"/>
<IDSymbol name="cmdidBlue" value="0x104"/>
</GuidSymbol>

按钮元素之前创建菜单元素，然后在它中定义的快捷菜单。

VB

<Menus>
<Menu guid="guidShortcutMenuPackageCmdSet" id="ColorMenu" type="Context">
<Strings>
<ButtonText>Color change</ButtonText>
<CommandName>ColorChange</CommandName>
</Strings>
</Menu>
</Menus>

一个快捷菜单不具有父级，因为它不是菜单或工具栏的一部分。

使用组元素，其中包含的快捷菜单项，来创建一个组元素，并将该组关联的快捷菜单。

XML

<Groups>
<Group guid="guidShortcutMenuPackageCmdSet" id="ColorGroup">
<Parent guid="guidShortcutMenuPackageCmdSet" id="ColorMenu"/>
</Group>
</Groups>

在按钮元素中，在快捷菜单上定义将显示单个命令。 按钮元素应该如下所示︰

XML

<Buttons>
<Button guid="guidShortcutMenuPackageCmdSet" id="ShortcutMenuCommandId" priority="0x0100" type="Button">
<Parent guid="guidSHLMainMenu" id="IDG_VS_WNDO_OTRWNDWS1"/>
<Icon guid="guidImages" id="bmpPic1" />
<Strings>
<ButtonText>ShortcutMenu</ButtonText>
</Strings>
</Button>

<Button guid="guidShortcutMenuPackageCmdSet" id="cmdidRed" priority="1" type="Button">
<Parent guid="guidShortcutMenuPackageCmdSet" id="ColorGroup" />
<Strings>
<ButtonText>Red</ButtonText>
</Strings>
</Button>

<Button guid="guidShortcutMenuPackageCmdSet" id="cmdidYellow" priority="3" type="Button">
<Parent guid="guidShortcutMenuPackageCmdSet" id="ColorGroup" />
<Strings>
<ButtonText>Yellow</ButtonText>
</Strings>
</Button>

<Button guid="guidShortcutMenuPackageCmdSet" id="cmdidBlue" priority="5" type="Button">
<Parent guid="guidShortcutMenuPackageCmdSet" id="ColorGroup" />
<Strings>
<ButtonText>Blue</ButtonText>
</Strings>
</Button>
</Buttons>

在 ShortcutMenuPackageGuids.cs，该命令的定义集 GUID、 快捷菜单和菜单项添加。

C#

public const string guidShortcutMenuPackageCmdSet = "00000000-0000-0000-0000-00000000"; // your GUID will differ
public const int ColorMenu = 0x1000;
public const int cmdidRed = 0x102;
public const int cmdidYellow = 0x103;
public const int cmdidBlue = 0x104;

这些是在 ShortcutMenuPackage.vsct 文件的 Symbols 部分中定义的相同命令 Id。 上下文组此处未包括因为只能在.vsct 文件中需要它。

实现的快捷菜单



本部分实现的快捷菜单和其命令。

ShortcutMenu.cs，在工具窗口中可以获取菜单命令服务中，但它所包含的控件不能。 下列步骤显示如何使菜单命令服务可向该用户控件。

在 ShortcutMenu.cs，添加以下 using 语句︰

C#

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

重写工具窗口 initialize （） 方法以获取菜单命令服务并将添加该控件，将菜单命令服务传递给构造函数︰

C#

protected override void Initialize()
{
commandService = (OleMenuCommandService)GetService(typeof(IMenuCommandService));
Content = new ShortcutMenuControl(commandService);
}

在快捷菜单工具窗口构造函数中，删除将控件添加的行。 构造函数现在应如下所示︰

C#

public ShortcutMenu() : base(null)
{
this.Caption = "ShortcutMenu";
this.BitmapResourceID = 301;
this.BitmapIndex = 1;
}

在 ShortcutMenuControl.xaml.cs，添加菜单命令服务的私有字段和更改控件构造函数来执行菜单命令服务。 然后使用菜单命令服务中添加上下文菜单命令。 ShortcutMenuControl 构造函数现在应类似下面的代码。 命令处理程序将在以后定义。

C#

public ShortcutMenuControl(OleMenuCommandService service)
{
this.InitializeComponent();
commandService = service;

if (null !=commandService)
{
// Create an alias for the command set guid.
Guid guid = new Guid(ShortcutMenuPackageGuids.guidShortcutMenuPackageCmdSet);

// Create the command IDs.
var red = new CommandID(guid, ShortcutMenuPackageGuids.cmdidRed);
var yellow = new CommandID(guid, ShortcutMenuPackageGuids.cmdidYellow);
var blue = new CommandID(guid, ShortcutMenuPackageGuids.cmdidBlue);

// Add a command for each command ID.
commandService.AddCommand(new MenuCommand(ChangeColor, red));
commandService.AddCommand(new MenuCommand(ChangeColor, yellow));
commandService.AddCommand(new MenuCommand(ChangeColor, blue));
}
}

在 ShortcutMenuControl.xaml，添加MouseRightButtonDown事件的顶层UserControl元素。
XAML 文件现在应如下所示︰

VB

<UserControl x:Class="TWShortcutMenu.ShortcutMenuControl"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
Background="{DynamicResource VsBrush.Window}"
Foreground="{DynamicResource VsBrush.WindowText}"
mc:Ignorable="d"
d:DesignHeight="300" d:DesignWidth="300"
Name="MyToolWindow"
MouseRightButtonDown="MyToolWindow_MouseRightButtonDown">
<Grid>
<StackPanel Orientation="Vertical">
<TextBlock Margin="10" HorizontalAlignment="Center">ShortcutMenu</TextBlock>
</StackPanel>
</Grid>
</UserControl>

在 ShortcutMenuControl.xaml.cs，将添加事件处理程序存根 （stub）。

C#

private void MyToolWindow_MouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
. . .
}

将以下代码添加到同一个文件 using 语句︰

C#

using Microsoft.VisualStudio.Shell;
using System.ComponentModel.Design;
using System;
using System.Windows.Input;
using System.Windows.Media;

实现

MyToolWindowMouseRightButtonDown

，如下所示的事件。

C#

private void MyToolWindow_MouseRightButtonDown(object sender, MouseButtonEventArgs e)
{
if (null != commandService)
{
CommandID menuID = new CommandID(
new Guid(ShortcutMenuPackageGuids.guidShortcutMenuPackageCmdSet),
ShortcutMenuPackageGuids.ColorMenu);
Point p = this.PointToScreen(e.GetPosition(this));
commandService.ShowContextMenu(menuID, (int)p.X, (int)p.Y);
}
}

这将创建CommandID对象的快捷菜单上，标识鼠标单击的位置，并通过使用在该位置打开快捷菜单ShowContextMenu方法。

实现命令处理程序。

C#

private void ChangeColor(object sender, EventArgs e)
{
var mc = sender as MenuCommand;

switch (mc.CommandID.ID)
{
case ShortcutMenuPackageGuids.cmdidRed:
MyToolWindow.Background = Brushes.Red;
break;
case ShortcutMenuPackageGuids.cmdidYellow:
MyToolWindow.Background = Brushes.Yellow;
break;
case ShortcutMenuPackageGuids.cmdidBlue:
MyToolWindow.Background = Brushes.Blue;
break;
}
}

在这种情况下，只有一种方法处理的菜单项的所有事件通过标识CommandID并相应地设置背景色。 如果菜单项中包含不相关的命令，您将创建一个单独的事件处理程序为每个命令。

测试工具窗口功能



生成项目并启动调试。 将显示的实验实例。

在实验实例中，单击视图 / 其他窗口，然后单击快捷菜单。 执行此操作应该会显示工具窗口。

右键单击工具窗口中的正文中。 应显示快捷方式菜单中有一个颜色的列表。

单击快捷菜单上的颜色。 工具窗口背景颜色应该更改为所选颜色。