VS2010 Extension实践

Posted 2020-09-08 张柯宇

在上一篇（VS2010 Extension (1)实践）里，主要展示了如何使用MEF扩展VS2010，来扩展编辑控制和展现自己的UI；在实现QuickToolbar的时候，发现MEF仅仅提供了很基本的编辑控制，如果需要高级的操作，比如注释选择的代码，就捉襟见肘，很是麻烦。

本篇我将展示如何深入挖掘VS2010 Extension，使它成为锋利的军刀，而不是绣花枕头。鉴于此，这里就从上面提到了的Feature——注释和取消注释选择的代码来剖析，希望可以为大家拓宽思路，更好的利用VS2010。

首先回顾一下上篇中的实现，当时是基于TextViewLine做注释代码的，这里有两个潜在问题：其一，TextViewLine，顾名思义，是“可视区域”的行，所以如果选择超出可视区域，超出的部分就没有注释掉；其二，当选择的结束位置在行的结尾时，无法实现IDE注释代码后保持Caret在选择结尾而不跳到下一行的行为，当尝试自己重新选择并移动Caret就会收到ITextSpanshot无效的异常。

上面提到了VS2010 Extension对编辑器的编辑行为的控制能力仅仅提供了通用的，比如Cut/Copy/Paste等等，而其他的诸如注释/取消注释代码，添加、删除、导航到Bookmark等程序员常用功能没有暴露出来，具体可以参考IEditorOperationsInterface（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.text.operations.ieditoroperations_methods%28VS.100%29.aspx），这里的所有Member表达了其所支持的编辑操作。总之，这条路只有这么几个目的地。

那么，还有其他方法吗？貌似走到了死胡同了，但是当我们使用IDE时候，却是可以很容易的通过Edit菜单找到所有的功能的，问题是，它们要怎样才能为我所用呢？

我首先想到的是在VSSDK中找找，结果一个名字看起来很顺眼的接口撞到眼里，它就是IVsUIShellInterface（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.interop.ivsuishell%28VS.100%29.aspx），MSDN上市这么说的：

This interface provides access to basic windowing functionality, including access to and creation of tool windows and document windows. provided by the environment.

也就是说这是一个由IDE提供的全局的Service，可以创建、访问工具窗口和编辑窗口。浏览一下这个所有Member，发现了一个叫IVsUIShell.PostExecCommand(...)（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.interop.ivsuishell.postexeccommand%28VS.100%29.aspx）的方法，MSDN描述说通过它可以异步执行Command，那么，只要找到注释代码的Command，在通过这个接口就可以实现VS IDE一样的注释代码的Feature了。酷毙了，就是它，当怎么得到它呢？现在请留心MSDN上的解释，就是上面我使用红色粗体表示出来的部分——这个由IDE提供的全局的Service，那么可以通过Package.GetGlobalService(...)（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.shell.package.getglobalservice%28VS.100%29.aspx）来获取：

IVsUIShell shell = Package.GetGlobalService(typeof(IVsUIShell)) as IVsUIShell;

 

接下来是找到自己需要Command，然后PostExecCommand就搞定了；而VS提供的Command有两部分组成：Guid和CommandID，这个大部分都在VSConstants Class（http://msdn.microsoft.com/en-us/library/microsoft.visualstudio.vsconstants%28VS.100%29.aspx）里面，以注释代码为例，其Guid是：VsConstants.VSStd2k，而CommandID是VSConstants.VSStd2kCmdID.COMMENTBLOCK。下面是我包装的注释和取消注释的代码片段：

 

public static void ProcessComments(bool comment) {     IVsUIShell shell = Package.GetGlobalService(typeof(IVsUIShell)) as IVsUIShell;     if (shell != null)     {         Guid std2k = VSConstants.VSStd2K;         uint cmdId = comment ?                   (uint)VSConstants.VSStd2KCmdID.COMMENT_BLOCK :                   (uint)VSConstants.VSStd2KCmdID.UNCOMMENT_BLOCK;         object arg = null;         shell.PostExecCommand(ref std2k, cmdId, 0, ref arg);     } }

至此，我们通过VSSDK提供的能力，顺利的挖掘出VS2010 Extension的部分宝藏，你是不是也有点心动，要自己去挖掘一点呢？

 

PS：

本文所讲解内容是根据练习之作而进行的，如果需要源代码，请自行到GCDN论坛下载，代码和VSIX安装程序均匀更新：

[VS2010扩展]浮动工具栏(http://gcdn.grapecity.com/showtopic-345.html