如何编程实现向Visual Studio的Toolbox添加控件(VS 2003, VS 2005, VS 2008)

更过内容：http://www.1x3x.net/blog/dotnet-world/2008/06/add-control-to-vs-toolbox.html

要不是因为手中的Framework项目需要在Windows Installer中对Visual Studio 2008的Toolbox添加控件，我也不会认识到让人纠结的ToolBoxItems.Add (EnvDTE，参见MSDN)… 不敢计算我在这个问题上浪费了多少生命，只是伤心为什么自己喜爱的产品连续3（4？2002？）个版本都没能修正这一个API。。。我只觉得有必要把这个问题总结一下(大多数资源来自于Google)，希望更多人看到，避免在这个问题上浪费时间

早在Visual Studio 2003时代，勇于实践的前人们在多次尝试后终于发现，要使用ToolBoxItems.Add方法对Toolbox添加包含控件的dll，必须念完三条准备咒语：

• 激活当前ToolboxTab

toolboxTab.Activate();

• 运行“View.PropertiesWindow”命令

dte.ExecuteCommand(“View.PropertiesWindow“, String.Empty);

• 选择第一个控件（Pointer）

toolboxTab.ToolBoxItems.Item(1).Select();

咒语颂完，法力生效，我们终于可以随心所欲地使用ToolBoxItems.Add方法了。为什么必须念那三条咒语呢？笔者没有研究过。

好了，两年后，2003的兄弟，2005，法力更加强大，旧的控件注册代码移植过来全部失效。这时，VS Extensibility团队的高僧站了出来，提供了一段代码： http://code.msdn.microsoft.com/vsx/Release/ProjectReleases.aspx?ReleaseId=147 代码的关键是…在注册控件之前，你必须创建一个”Dummy”的WinForms项目，并且，由于添加项目时的EnvDTE.Solution2.AddFromTemplate方法可能会持续很长一段时间，为了防止程序因停止响应，你需要实现IMessageFilter。然后这个方法怎么看也像是个偏门。。。总是不优雅。笔者未曾测试过这段代码。

也许是个补偿吧，最后，MS推出了ToolboxControlsInstaller （TCI） - 一个独立的package，终于提供了一个新的方法解决了Toolbox控件注册问题。对于VS 2005，TCI是一个单独的安装包，你需要另外下载并安装（包含在VS 2005 Version 4 SDK里）（http://www.microsoft.com/downloads/details.aspx?familyid=51A5C65B-C020-4E08-8AC0-3EB9C06996F4&displaylang=en）；对于VS 2008，它已经被集成在了VisualStudio里边，不需要额外的安装。要验证你的VisualStudio是否安装了TCI，检查以下注册表项即可： HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/VisualStudio/9.0/Packages/{2c298b35-07da-45f1-96a3-be55d91c8d7a} （对于2005，把”9.0″换成”8.0″）{2c298b35-07da-45f1-96a3-be55d91c8d7a}即是TCI Package的GUID 新的魔法书出来了，自然要研习把玩一番。MS提供了一套VS 2008的SDK，包含了这样的代码示例。在这些示例中，大多用到的是MSBuild以及WiX配置来进行程序的编译，打包成安装程序，第一次看上去还是有点晕的。在研究了示例提供的WiX配置文件之后，了解到使用TCI注册Toolbox最核心的口诀是以下几条：

1. 在你的安装包中引入Merge Module - TbxCtrlsInstDefaultItemsCA.msm （在哪里找到它？{Program Files}/Microsoft Visual Studio 2008 SDK/VisualStudioIntegration/Redistributables）这个msm负责通知TCI有新的控件安装到了Toolbox中 - 这样下一次Visual Studio打开Toolbox的时候，就会自动安装那些新的ToolboxItem。当然，这个msm所做的事情，也可以自己写代码实现 - 但有现成的用又何乐不为呢！VS 2008 SDK: http://www.microsoft.com/downloads/details.aspx?FamilyID=30402623-93CA-479A-867C-04DC45164F5B&displaylang=en
2. 将待安装的ToolboxItem写入注册表。

对于已在GAC内的控件Assembly，直接建立这样一个Key HKEY_LOCAL_MACHINE/SOFTWARE/Microsoft/VisualStudio/9.0/ToolboxControlsInstaller/LuxelLab.LabWinControl, Version=1.0.0.0, Culture=neutral, PublicKeyToken=e932685e2a14e8b1, processorArchitecture=MSIL 并为其创建一个无名的String Value - 这个就是Toolbox Tab的名称。该Assembly下边的所有Toolbox控件都会被自动安装到这个Toolbox Tab下边。

 

对于欲从文件系统安装的控件，在上一个Key的基础上，为其添加一个名为”Codebase”的String Value - 代表dll的位置

  把”VisualStudio”替换成”VCExpress”，或者”VCSExpress”等等，即可实现为各种Express版本的IDE安装Toolbox Controls。该方法也适用于 WebControl，WPFControl的安装

好啦，就那么简单，下一次打开IDE的Toolbox时，在一小段”Initializing Toolbox”的功夫之后，安装的控件们就出现在工具箱里了（看不到？Show All试试），很可靠，童叟无欺。