Vs2005中对add-ins的支持要比2003好的多了,看了一些这方面的文章,忍不住技痒,自己做了一个小东西,用快捷键Alt + G插入 Guid, 希望可以给大家带来些许的方便,也希望可以激发大家的灵感开发出方便好用的add-in来提高我们的开发效率。
Vs2005中对add-ins的支持要比2003好的多了,看了一些这方面的文章,忍不住技痒,自己做了一个小东西,用快捷键Alt + G插入 Guid, 希望可以给大家带来些许的方便,也希望可以激发大家的灵感开发出方便好用的add-in来提高我们的开发效率。
闲话少叙,先给大家提供我的这个小工具的程序集和源文件:
程序集下载,源文件下载
你可以将程序集中的两个文件复制到My Documents\Visual Studio 2005\addins 文件夹下面,然后就可以打开Vs 2005随便打开一个代码文件或者html文件,然后按Alt + G看看效果了。
注意:程序在vs2005 team edtion中文版上面测试通过,如果大家有用英文版的需要改一下源文件,重新编译一下才可以使用,很简单的。
因为要简要的说一下我在开发过程中遇到的问题,所以把源文件贴一下,方便大家看
GuidPickerCode
using System;
using Extensibility;
using EnvDTE;
using EnvDTE80;
using Microsoft.VisualStudio.CommandBars;
using System.Resources;
using System.Reflection;
using System.Globalization;
using System.Collections;
using System.Windows.Forms;
namespace Yueyar.Tools.AddIns.GuidGeter
{
/**//// <summary>用于实现外接程序的对象。</summary>
/// <seealso class='IDTExtensibility2' />
public class Connect : IDTExtensibility2, IDTCommandTarget
{
/**//// <summary>实现外接程序对象的构造函数。请将您的初始化代码置于此方法内。</summary>
public Connect()
{
}
private ArrayList _controlList = new ArrayList();
const string COMMAND_NAME = "Yueyar_InsertGuid";
const string COMMAND_FULLNAME = "Yueyar.Tools.AddIns.GuidGeter.Connect.Yueyar_InsertGuid";
const string TEXT_DOCUMENT = "TextDocument";
/**//// <summary>实现 IDTExtensibility2 接口的 OnConnection 方法。接收正在加载外接程序的通知。</summary>
/// <param term='application'>宿主应用程序的根对象。</param>
/// <param term='connectMode'>描述外接程序的加载方式。</param>
/// <param term='addInInst'>表示此外接程序的对象。</param>
/// <seealso class='IDTExtensibility2' />
public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
bool isExists = false;
foreach (Command cmd in _applicationObject.Commands)
{
if (cmd.Name == COMMAND_FULLNAME)
{
isExists = true;
break;
}
}
if (!isExists)
{
try
{
object[] contextUIGUIDs = new object[] { };
Command command = _applicationObject.Commands.AddNamedCommand(_addInInstance,
COMMAND_NAME,
"插入Guid",
"插入Guid",
true,
22,
ref contextUIGUIDs,
(int)vsCommandStatus.vsCommandStatusSupported + (int)vsCommandStatus.vsCommandStatusEnabled);
command.Bindings = (object)new object[] { (object)"文本编辑器::Alt+G" };
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
}
}
/**//// <summary>实现 IDTExtensibility2 接口的 OnDisconnection 方法。接收正在卸载外接程序的通知。</summary>
/// <param term='disconnectMode'>描述外接程序的卸载方式。</param>
/// <param term='custom'>特定于宿主应用程序的参数数组。</param>
/// <seealso class='IDTExtensibility2' />
public void OnDisconnection(ext_DisconnectMode disconnectMode, ref Array custom)
{
if (_controlList != null && _controlList.Count > 0)
{
CommandBarButton button = _controlList[0] as CommandBarButton;
object obj = null;
button.Delete(obj);
}
}
/**//// <summary>实现 IDTExtensibility2 接口的 OnAddInsUpdate 方法。当外接程序集合已发生更改时接收通知。</summary>
/// <param term='custom'>特定于宿主应用程序的参数数组。</param>
/// <seealso class='IDTExtensibility2' />
public void OnAddInsUpdate(ref Array custom)
{
}
/**//// <summary>实现 IDTExtensibility2 接口的 OnStartupComplete 方法。接收宿主应用程序已完成加载的通知。</summary>
/// <param term='custom'>特定于宿主应用程序的参数数组。</param>
/// <seealso class='IDTExtensibility2' />
public void OnStartupComplete(ref Array custom)
{
}
/**//// <summary>实现 IDTExtensibility2 接口的 OnBeginShutdown 方法。接收正在卸载宿主应用程序的通知。</summary>
/// <param term='custom'>特定于宿主应用程序的参数数组。</param>
/// <seealso class='IDTExtensibility2' />
public void OnBeginShutdown(ref Array custom)
{
}
/**//// <summary>实现 IDTCommandTarget 接口的 QueryStatus 方法。此方法在更新该命令的可用性时调用</summary>
/// <param term='commandName'>要确定其状态的命令的名称。</param>
/// <param term='neededText'>该命令所需的文本。</param>
/// <param term='status'>该命令在用户界面中的状态。</param>
/// <param term='commandText'>neededText 参数所要求的文本。</param>
/// <seealso class='Exec' />
public void QueryStatus(string commandName, vsCommandStatusTextWanted neededText, ref vsCommandStatus status, ref object commandText)
{
if (neededText == vsCommandStatusTextWanted.vsCommandStatusTextWantedNone)
{
if (commandName == COMMAND_FULLNAME)
{
status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported | vsCommandStatus.vsCommandStatusEnabled;
return;
}
}
}
/**//// <summary>实现 IDTCommandTarget 接口的 Exec 方法。此方法在调用该命令时调用。</summary>
/// <param term='commandName'>要执行的命令的名称。</param>
/// <param term='executeOption'>描述该命令应如何运行。</param>
/// <param term='varIn'>从调用方传递到命令处理程序的参数。</param>
/// <param term='varOut'>从命令处理程序传递到调用方的参数。</param>
/// <param term='handled'>通知调用方此命令是否已被处理。</param>
/// <seealso class='Exec' />
public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled)
{
handled = false;
if (executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault)
{
if (commandName == COMMAND_FULLNAME)
{
Document activeDoc = _applicationObject.DTE.ActiveDocument;
if (activeDoc == null)
{
MessageBox.Show("没有活动文档。");
return;
}
TextDocument textDoc = activeDoc.Object(TEXT_DOCUMENT) as TextDocument;
if (textDoc == null)
{
MessageBox.Show("请选择要插入Guid的文档。");
return;
}
EditPoint editPoint = textDoc.Selection.ActivePoint.CreateEditPoint();
string copiedText = Clipboard.GetText();
if (!textDoc.Selection.IsEmpty) textDoc.Selection.Cut();
editPoint.Insert(Guid.NewGuid().ToString());
Clipboard.SetText(copiedText);
handled = true;
}
}
}
private DTE2 _applicationObject;
private AddIn _addInInstance;
}
}
我在开发中遇到的问题:
1._applicationObject.Commands.AddNamedCommand方法抛出 “Value does not fall within the expected range.”的异常,但是没有提示哪一个参数有问题,这个问题困扰了我好长时间,原因是CommandName参数中不能包含“.”,因为这个方法在创建Command的时候会在command的名字的前面加上命名空间的名字和Connect的类名,所以大家在开发的时候要记得不能给此方法的CommandName参数赋予包含“.”的值。
2.由于第1点中提到的原因我们在判断IDE中是否已经有了这个命令的时候记得要用全名,而不能用第1点中的CommandName。
3.注意Vs2005是英文版的还是中文版,因为add-ins中的CommandBarControl都是通过Caption来取的,而Caption不同的语言版本是不一样的,所以你看了老外的资料中对工具菜单的引用用的名字是Tool时,如果你也用Tool的话就会出问题,这时候我们中文版的用户应该使用“工具(&T)”。
4.同样是因为多语言的原因我们在使用键盘快捷键的时候也有不同,中文的键盘设置可能是这样子的:全局::Ctrl+Shift+7,类关系图::Shift+Alt+B而英文版的就不同了。
5.textDoc.Selection.Delete(count)方法总是不能按照理想的效果执行,总是会多删除一些字符,大家可以看到源文件中我用的是Cut方法,这个问题我现在也不知道是什么原因,如果大家知道,请告诉我,谢谢。
希望这些能够对大家有所帮助。