VS 2010 : 如何开发和部署Outlook 2010插件(Add-in)

深藏阁楼爱情的钟 2022-07-13 12:29 379阅读 0赞

[VS 2010 : 如何开发和部署Outlook 2010插件(Add-in)][VS 2010 _ _Outlook 2010_Add-in]

## 概述： ##

这篇文章，我将通过一个简单的例子，给大家分享一下如何在VS 2010中开发和部署Outlook 2010的插件（Add-in）

## 首先，我要说一下什么是插件（Add-in） ##

插件一般是对现有程序的扩展，微软的Office系统公开了一套接口，可以很方便地让开发人员基于这些接口去实现对Office应用程序的增强。这个接口，准确地说，就是Extensibility.IDTExtensibility2.

当然，除了Office，有很多应用程序都支持类似的扩展机制，例如IE，以及Visual Studio本身，都支持一定程序的扩展。

## 其次，我要说一下以前是怎么开发插件Add-in的 ##

开发Office插件（Add-in）的途径有各种各样的，我大致总结分为三类：

*  **VBA 开发**：这个是基于Visaul Basic for Application这套开发模型做的一些定制。这种定制的限制比较多一些，但开发难度相对来说更加低一些。做过VBA开发的朋友都知道，VBA是脱离不了应用程序本身的。例如Excel的VBA编辑器如下图所示

[![image][]][image 1]

*  **VC++,Visual Basic开发**：这种开发方式允许我们在VC++,或者VB 6中，直接实现Extensibility.IDTExtensibility2这套接口，并且可以更加灵活，做更加强大的一些定制。目前的Office应用程序中，默认就安装好了的一些插件，都是这种方式做的。例如下图是我的Outlook默认安装的一些插件列表

[![image][image 2]][image_image 2]

【备注】很早之前，我也用VB 6做过这方面的开发。但现在基本连VB 6的安装程序都找不到了。所以这里就不截图了，其实就是有一个项目模板，然后实现接口。开发这种插件，关键在于对Office本身内部的一些对象模型熟悉。

*  **VSTO开发**：所谓VSTO，全称是Visual Studio Tools for Office.我记得是从VS 2003开始提供了VSTO 1.0，简而言之，就是允许在.NET的开发环境中开发Office应用程序或者插件。这种方式有着显而易见的好处，就是能力增强，因为可以用到.NET的整套框架。VSTO发展到现在有几个版本，分别如下
    
     *  VS 2003: VSTO 1.0
     *  VS 2005: VSTO 2.0
     *  VS 2008: VSTO 3.0
     *  VS 2010: VSTO 4.0

*   *  VSTO 之前的版本有一些不太好的地方是部署，不要小看部署这个环节。如果你曾经花了很多精力写出来了一个很好的插件，但是因为各式各样的部署问题导致没有办法很顺利地分发给你的用户，那种感觉是很让人沮丧的。VSTO的解决方案有相当多的一些环境依赖，另外还需要提升.NET中的安全策略等等。
     *  一个好消息是，现在的新版本中，开发和部署将是相对更加容易了。在开发方面，模板更加好用，也提供了对Ribbon的内置支持，部署方面，我们可以通过ClickOnce技术发布到网站，或者打包成一个vsto压缩包文件，很容易地进行部署。本文我们就来用一个简单例子进行说明。

## 然后，我们来看看在新版的开发工具中，如何快速高效地开发插件（Add-in） ##

作为演示，我主要侧重于开发和部署的流程。我们要实现的一个插件，其场景比较简单：

我们需要在Outlook中添加一个新的Ribbon按钮，该按钮点击之后，可以弹出一个窗口，允许我们从Excel文件中导入联系人

那就让我们开始吧

## 第一步：创建一个Add-in项目 ##

[![image][image 3]][image_image 3]

这个项目模板会自动创建下面的项目结构

[![image][image 4]][image_image 4]

【备注】在ThisAddin这个类中，可以很方便地访问到Outlook的当前实例，只要使用如下的代码即可

this.Application

## 第二步：添加一个Ribbon ##

我们需要为Outlook添加一个新的Ribbon按钮，事实上这很容易做到。

[![image][image 5]][image_image 5]

我们选择Ribbon(Visual Designer)，这样就可以在可视化界面中设计了

[![image][image 6]][image_image 6]

我们首先需要设置一下，这个Ribbon是在什么地方要显示。在下图中，我们将RibbonType修改为Microsoft.Outlook.Explorer，这样的意思是说，我们这个Ribbon是现在在Outlook默认的那个管理器窗口中的

[![image][image 7]][image_image 7]

接下来，我们可以添加一个按钮到group1中去。工具箱中有很多可用的控件

[![image][image 8]][image_image 8]

我最好做好的Ribbon看起来像下面这样

[![image][image 9]][image_image 9]

## 第三步：实现简单的逻辑 ##

接下来，我们可以为这个按钮实现简单的逻辑

通过双击该按钮，会产生一个事件处理器

[![image][image 10]][image_image 10]

我简单地实现代码如下

using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using Microsoft.Office.Tools.Ribbon;
    using System.Windows.Forms;
    
    namespace OutlookAddInSample
    {
        public partial class MyRibbon
        {
            private void MyRibbon_Load(object sender, RibbonUIEventArgs e)
            {
    
            }
    
            private void btImport_Click(object sender, RibbonControlEventArgs e)
            {
                Form form = new Form()
                {
                    Text = "Import Contacts from Excel File",
                    StartPosition=FormStartPosition.CenterScreen
                };
                form.Show();
            }
        }
    }

## 第四步：调试 ##

完成如上的操作之后，一个最简单的Add-in就做好了。那么如何进行调试呢？

没错，直接按F5就可以进行调试了。此时，Outlook会自动打开，然后我们的Ribbon也确实能看到了

[![image][image 11]][image_image 11]

点击该按钮，我们也确实可以看到一个窗口被显示出来了

[![image][image 12]][image_image 12]

同时，我们在Outlook的选项对话框中也能看到这个插件的信息

[![image][image 13]][image_image 13]

## 第五步：发布 ##

如果我们在本机做好了调试，那么如何分发给用户呢？以前我们一般会制作一个MSI的安装程序，现在你依然可以这么做。但我今天主要介绍的是一种更加方便的部署方式，就是通过ClickOnce技术发布到网站或者文件夹中。

[![image][image 14]][image_image 14]

[![image][image 15]][image_image 15]

[![image][image 16]][image_image 16]

【注意】这里的location是可以有下面几种的。但我这里保持默认的选择，直接发布到一个文件夹

发布如果没有遇到什么错误的话，会生成下面的一个目录

[![image][image 17]][image_image 17]

我们一般可以将这个目录，打包给用户即可。

## 第六步：安装 ##

接下来，用户如果拿到了这些文件，应该如何安装使用呢？其实也很简单，它可以双击setup.exe，或者设置直接双击vsto文件也可以

一般情况下，会有一个提示。

[![image][image 18]][image_image 18]

点击“install”

[![image][image 19]][image_image 19]

然后，我们再去打开Outlook的话，仍然是可以看到这个Add-in以及它所添加的Ribbon的

[![image][image 20]][image_image 20]

## 第七步：卸载 ##

最后，如果用户需要卸载这个插件，应该怎么做呢？

他们可以在Programs and Features窗口中，找到这个插件，然后点击“Uninstall”即可

[![image][image 21]][image_image 21]

## 总结 ##

通过本文的简单实例，大家可以了解到在VS 2010中开发Outlook 2010插件相比较之前而言，有了很大的一些改进。当然，VS 2010也可以开发Office 2007版本的插件。

分类: [ Office & SharePoint 及其开发][Office _ SharePoint]

好文要顶 关注我  收藏该文 ![icon_weibo_24.png][] ![wechat.png][]

[![20150801064324.png][]][20150801064324.png 1]

[陈希章][20150801064324.png 1]  
[关注 - 4][- 4]  
[粉丝 - 1960][- 1960]

荣誉： [推荐博客][Link 1]

\+加关注

[« ][Link 2]上一篇： [“人在旅途”之随想以及旅游指南（travel.msra.cn）简介][Link 2]  
[» ][Link 3]下一篇： [如何设置Hyper-V的虚拟机快捷方式][Link 3]

posted on 2010-05-08 22:11 [ 陈希章][Link 4] 阅读(11788) 评论(15) [ 编辑][Link 5] [ 收藏][Link 6]

### 评论 ###

#### [\#1楼][1]\[楼主\] 2010-05-08 22:14 [陈希章][Link 4] [  ][Link 7] ####

为便于大家学习和理解，我将范例程序打包放在下面地址  
[http://files.cnblogs.com/chenxizhang/OutlookAddInSample.rar][http_files.cnblogs.com_chenxizhang_OutlookAddInSample.rar]  
  
有兴趣的朋友可以参照实现。如果你没有VS 2010的开发环境，也可以直接点击那个setup看看安装是否能用？

支持(0) 反对(0)

/images/20220713/4ba333eb4fb8430680ccab284997808a.png

#### [\#2楼][2] 2010-05-08 23:36 [ph580][] [  ][Link 8] ####

我们最近也用上了最新版

支持(0) 反对(0)

http://pic.cnblogs.com/face/u27022.jpg

#### [\#3楼][3] 2012-01-30 13:12 [技术弟弟][Link 9] [  ][Link 10] ####

学习了！最近正好要做addin开发

支持(0) 反对(0)

http://pic.cnblogs.com/face/u352925.jpg?id=22130316

#### [\#4楼][4] 2012-01-30 14:36 [技术弟弟][Link 9] [  ][Link 10] ####

有个问题。我在debug的时候那个插件就到我的outlook里了。关了vs，那个插件还在。由于没有publish 。我无法在电脑里卸载。我如何解除这个addin和我outlook的关联呢？

支持(0) 反对(0)

http://pic.cnblogs.com/face/u352925.jpg?id=22130316

#### [\#5楼][5]\[楼主\] 2012-01-31 13:49 [陈希章][Link 4] [  ][Link 7] ####

[@][4] 技术弟弟  
在vs中里面，选择项目，然后点击“ Clean solution”

支持(0) 反对(0)

/images/20220713/4ba333eb4fb8430680ccab284997808a.png

#### [\#6楼][6] 2012-02-08 13:26 [dj080808][] [  ][Link 11] ####

lz你好，请教个问题：outlook开着的情况下如果我去卸载某个自己写的add-in，这时候该add-in还在内存中，需要重启outlook才会不见。所以我要在卸载该add-in的时候跳出个提示需要重启outlook才能生效，这个卸载程序该怎么实现

支持(0) 反对(0)

#### [\#7楼][7]\[楼主\] 2012-02-08 17:29 [陈希章][Link 4] [  ][Link 7] ####

[@][6] dj080808  
这个需求，我想可以自定义一个安装程序，添加自定义操作，应该是可以的  
  
参考 [ http://msdn.microsoft.com/zh-cn/library/2kt85ked.aspx][http_msdn.microsoft.com_zh-cn_library_2kt85ked.aspx]

支持(0) 反对(0)

/images/20220713/4ba333eb4fb8430680ccab284997808a.png

#### [\#8楼][8] 2012-04-28 10:44 [不死鸟之魂][Link 12] [  ][Link 13] ####

我按F5之后，可以看到outlook启动界面显示“正在加载...”，但是启动之后不显示我的工具栏。  
我已经设置了Microsoft.Outlook.Explorer，并且在outlook加载项中可以看到我的程序在加载项列表中（没有禁用）。  
不知道是什么原因。

支持(0) 反对(0)

#### [\#9楼][9]\[楼主\] 2012-05-03 12:31 [陈希章][Link 4] [  ][Link 7] ####

[@][8] 不死鸟之魂  
有没有打勾启动

[VS 2010 _ _Outlook 2010_Add-in]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html
[image]: /images/20220713/5f7fd8b8c1db45a1b3f3c78745bb2d60.png
[image 1]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_2.png
[image 2]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_1.png
[image_image 2]: /images/20220713/aa8ff3e360644f54a2cfc444a0c40f29.png
[image 3]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_2.png
[image_image 3]: /images/20220713/bec9a44dbbbd46738e6a37589eacf915.png
[image 4]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_3.png
[image_image 4]: /images/20220713/57922ed467044290b692c7f630dc38ea.png
[image 5]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_4.png
[image_image 5]: /images/20220713/141b1bf9000a4a7a9ba68650c17ae524.png
[image 6]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_5.png
[image_image 6]: /images/20220713/8b94d2604e674ccea07206efe9e9f03a.png
[image 7]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_6.png
[image_image 7]: /images/20220713/5d9e69aee8974053bac1b05134eeb4d2.png
[image 8]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_7.png
[image_image 8]: /images/20220713/2577e82b017044cc9ab5a2fcf65f9028.png
[image 9]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_8.png
[image_image 9]: /images/20220713/c9f125cc518e4c03ac5e5f0be3d99ac7.png
[image 10]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_9.png
[image_image 10]: /images/20220713/928aaa995cf44c1b89c15b10278355e0.png
[image 11]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_10.png
[image_image 11]: /images/20220713/26208c78d867487183fb9011217115d7.png
[image 12]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_11.png
[image_image 12]: /images/20220713/1f995bbaea8f47a6b044d82e02170d15.png
[image 13]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_12.png
[image_image 13]: /images/20220713/72f774f1cb744d579f8ce526c6267399.png
[image 14]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_13.png
[image_image 14]: /images/20220713/95acf7432edf4881b34ed31363f23fb7.png
[image 15]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_14.png
[image_image 15]: /images/20220713/65562c55a6b849a1952044ac8c5b487b.png
[image 16]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_15.png
[image_image 16]: /images/20220713/30a630595f3b4acf9607066b65c6079f.png
[image 17]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_16.png
[image_image 17]: /images/20220713/5ba8e92ebbbc49388df08048765b9e37.png
[image 18]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_17.png
[image_image 18]: /images/20220713/f514c326285348908aa130bdab8bc173.png
[image 19]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_18.png
[image_image 19]: /images/20220713/087763725f1240babba1acaff3c05ea0.png
[image 20]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_19.png
[image_image 20]: /images/20220713/5990783830d340108f137303fb8c84b6.png
[image 21]: http://images.cnblogs.com/cnblogs_com/chenxizhang/WindowsLiveWriter/VS2010Outlook2010Addin_13417/image_thumb_20.png
[image_image 21]: /images/20220713/a96fe89f9cc24916a82ff37a53633d79.png
[Office _ SharePoint]: http://www.cnblogs.com/chenxizhang/category/136065.html
[icon_weibo_24.png]: http://common.cnblogs.com/images/icon_weibo_24.png
[wechat.png]: /images/20220713/f2ebc4e8299e42cfa7afbe15ace4bb0b.png
[20150801064324.png]: /images/20220713/4ba333eb4fb8430680ccab284997808a.png
[20150801064324.png 1]: http://home.cnblogs.com/u/chenxizhang/
[- 4]: http://home.cnblogs.com/u/chenxizhang/followees
[- 1960]: http://home.cnblogs.com/u/chenxizhang/followers
[Link 1]: http://www.cnblogs.com/expert/
[Link 2]: http://www.cnblogs.com/chenxizhang/archive/2010/05/07/1729612.html
[Link 3]: http://www.cnblogs.com/chenxizhang/archive/2010/05/10/1732067.html
[Link 4]: http://www.cnblogs.com/chenxizhang/
[Link 5]: https://i.cnblogs.com/EditPosts.aspx?postid=1730766
[Link 6]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#
[1]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#1819668
[Link 7]: http://msg.cnblogs.com/send/%E9%99%88%E5%B8%8C%E7%AB%A0
[http_files.cnblogs.com_chenxizhang_OutlookAddInSample.rar]: http://files.cnblogs.com/chenxizhang/OutlookAddInSample.rar
[2]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#1819708
[ph580]: http://www.cnblogs.com/ph580/
[Link 8]: http://msg.cnblogs.com/send/ph580
[3]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2298736
[Link 9]: http://www.cnblogs.com/techborther/
[Link 10]: http://msg.cnblogs.com/send/%E6%8A%80%E6%9C%AF%E5%BC%9F%E5%BC%9F
[4]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2298793
[5]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2299391
[6]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2304606
[dj080808]: http://home.cnblogs.com/u/373604/
[Link 11]: http://msg.cnblogs.com/send/dj080808
[7]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2304833
[http_msdn.microsoft.com_zh-cn_library_2kt85ked.aspx]: http://msdn.microsoft.com/zh-cn/library/2kt85ked.aspx
[8]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2365843
[Link 12]: http://www.cnblogs.com/ray2003/
[Link 13]: http://msg.cnblogs.com/send/%E4%B8%8D%E6%AD%BB%E9%B8%9F%E4%B9%8B%E9%AD%82
[9]: http://www.cnblogs.com/chenxizhang/archive/2010/05/08/1730766.html#2368545