我的VSTO之路(二):VSTO程序基本知识

原文:我的VSTO之路(二):VSTO程序基本知识

开始之前,首先我介绍一下我的开发环境:VS2010 + Office 2010,是基于.Net framework 4.0和VSTO 4.0。以下的范例代码都基于这个,如果你使用的是VS2008,那么问题也不大,基本可以移植过去。需要注意的是.Net framework 4.0中增加了dynamic类型可选参数,而这两点新的特性在VSTO 4.0中被广泛使用,新特性的详细内容我就不介绍了,(其实介绍的地方很多,Google一下就可以了),移植的时候需要稍微调整一下代码。

创建VSTO项目

环境搭建

要开发VSTO项目,环境搭建比较简单,微软这方面做得都做不错。只要安装了VS2010(需要勾选VSTO 4.0)和Office2010即可。VS2008配合Office2007也可以轻松搭建开发环境。

创建项目

选择创建新项目->C#->Office,然后选择Word 2010 Add-in,如下图:

可以看到图中除了Word 2010 Add-in,还有Word 2010 Document和Word 2010 Template这两种项目类型。它们的区别在于,Add-in属于Application level,即是一个插件,每次Word启动的时候都会加载这个插件。而Document和Template属于Document Level,这种项目会生成一个Word文件(Document项目会生成.docx文件,而Template会生成.dotx),你写的代码只有在运行这个特定的Word文件的时候才会起作用。

添加自定义的Ribbon

右击项目->添加新的Item->Office->Ribbon (Visual Designer),如下图:

 

往Ribbon上,添加一个按钮,并取名为Hello

 

双击Hello按钮,在OnClick中,添加如下代码:

   1:          private void btHello_Click(object sender, RibbonControlEventArgs e)
   2:          {
   3:              System.Windows.Forms.MessageBox.Show("Hello World!");
   4:          }

按F5运行当前程序,VS会帮你自动开始一个新的Word实例,然后在Word中选择Add-ins标签页,点击Hello按钮。如果你顺利看到Hello Word!对话框,就说明你的第一个VSTO程序,顺利完成了。

对于我们的一个VSTO程序,我们做一些小的优化。从前一张图我们可以看到,我们的Ribbon和其他插件的Ribbon都挤在了Add-ins,这个Tabs中。我们现在要把我们的Ribbon独立出来。在VS中,打开Ribbon的设计界面,并选择Ribbon Tab,如下图,把ControlIdType改为Custom,然后把ControlID改为MyFirstAddin,这样我们的Ribbon会独占一个Ribbon Tab。

 

* 这里有个小Trick,如果你的客户希望你把自己建的Ribbon插入到Office自己的Ribbon里面去,我们也可以实现。把ControlIdType设定为Office,并把OfficeID设定为TabHome,如下图:

 

运行界面

其他的OfficeID可以到这里查看:Office 2010 IDsOffice 2007 IDs

 

添加Task Pane

创建Task Pane

Task Pane是一个很有用的控件,它可以驻留在Office程序的窗口上,让开发者更具自己的需求创建界面。首先我们先创建一个User Control,之后这个User Control将嵌入在Task Pane中。而我们所添加的代码,主要也加在这个User Control中。

 

在UserControl上放一个Label,我们暂时不在这里写进一步的代码:

 

在ThisAddIn.cs文件中,进行如下修改,这样在这样Addin被加载时,就会显示Task Pane:

   1:      public partial class ThisAddIn
   2:      {
   3:          public CustomTaskPane _MyCustomTaskPane = null;
   4:   
   5:          private void ThisAddIn_Startup(object sender, System.EventArgs e)
   6:          {
   7:              UCForTaskPane taskPane = new UCForTaskPane();
   8:              _MyCustomTaskPane = this.CustomTaskPanes.Add(taskPane, "My Task Pane");
   9:              _MyCustomTaskPane.Width = 200;
  10:              _MyCustomTaskPane.Visible = true;
  11:          }
  12:   
  13:          private void ThisAddIn_Shutdown(object sender, System.EventArgs e)
  14:          {
  15:          }
  16:   
  17:          #region VSTO generated code
  18:          // 内容被省略
  19:          #endregion
  20:      }

 

运行结果:

 

将Task Pane与Ribbon关联

我们已经完成了一个Task Pane,接下去要用之前创建的Ribbon控制Task Pane的显示。先对之前的Ribbon做一些修改,增加两个按钮,同时我们对界面做一些美化,具体步骤我这里不详述了,界面如下图:

为"Open Task Pane"和"Close Task Pane"添加Onclick事件,代码如下:

   1:          private void btnOpen_Click(object sender, RibbonControlEventArgs e)
   2:          {
   3:              if (Globals.ThisAddIn._MyCustomTaskPane != null)
   4:              {
   5:                  Globals.ThisAddIn._MyCustomTaskPane.Visible = true;
   6:              }
   7:          }
   8:   
   9:          private void btnClose_Click(object sender, RibbonControlEventArgs e)
  10:          {
  11:              if (Globals.ThisAddIn._MyCustomTaskPane != null)
  12:              {
  13:                  Globals.ThisAddIn._MyCustomTaskPane.Visible = false;
  14:              }
  15:          }

 

运行你的程序,便可以看到结果了。

本文总结

到这里,我介绍了VSTO的开发方法,以及Ribbon和Task Pane的基本知识,本文中的范例程序可以在这里下载:MyFirstAddin.zip。 在之后的文章中,我会深入介绍Word、Excel和Outlook的具体开发实例以及开发的细节。详细请看,我之前写的序,http://www.cnblogs.com/izualx/archive/2011/04/30/2033289.html

本文欢迎转载,但请保留出处,大家如果有问题,可以联系我 justin.tyrael@gmail.com

时间: 2024-08-01 13:58:11

我的VSTO之路(二):VSTO程序基本知识的相关文章

我的VSTO之路(三):Word基本知识

原文:我的VSTO之路(三):Word基本知识 在前一篇文章中,我初步介绍了如何如何开发一个VSTO程序,在本文中,我将进一步深入介绍Word的插件开发.Word是一个大家在日常工作中一直接触的文档工具,也是微软最赚钱的产品之一.从最初的Word 1.0到现在的Word 2010历经了13代的演化,已经成为了一个比较复杂的系统.(这里稍微跑题一下,Office 2010的版本代号是version 14,但是我为什么说Word一共演化了13代呢?因为Office并没有Version 13,上一代的

我的VSTO之路:序

原文:我的VSTO之路:序 VSTO是微软提供给.Net开发人员的一个接口,通过他我们可以对Office程序做一些处理.但是这个接口并不尽善尽美,相比微软的很多其他产品,VSTO的稳定性并不好,相关的文档也很少.这种情况下,很多问题需要我们程序员自己去克服.我自己从08年进了现在这家公司,断断续续做VSTO开发已经快2年半了,不敢说对VSTO精通,但至少已经有了深入的解,尤其对开发中的一些Trick和一些Bug.准备写点东西记录一下这两年来的心路历程.同时也感慨于国内的VSTO文档资料实在匮乏,

我的VSTO之路(四):深入介绍Word开发

原文:我的VSTO之路(四):深入介绍Word开发 在上一篇文章中,我介绍了Word的对象模型和一些基本开发技巧.为了更好的介绍Word插件开发,我为本文制作了一个Word书签的增强版,具体功能是让用户在Word中选择一段文本,为它添加书签并其标志为高亮,同时用户可以为这段书签写注释,以后当用户点击这个书签时,我就会显示注释.以下是我录制的视频介绍:   这个插件将包括以下几个技术点: 添加右键菜单 添加右键菜单.控制右键菜单显示 WindowBeforeRightClick 事件 删除右键菜单

我的VSTO之路(五):Outlook初步开发之联系人扩展

原文:我的VSTO之路(五):Outlook初步开发之联系人扩展 上一讲我们完成对Word的介绍,文本开始,我将着重介绍Outlook.Outlook是微软Office中一个非常实用的工具,尤其在一个拥有Windows Domain的公司局域网中,Outlook是员工最常用的通讯工具,所以对Outlook实行进一步的定制开发的需求量是很大的.本文中,我先以联系人的扩展为开始,讲解如何开发一个强大的Outlook插件.   故事的开始 首先我们假设一个场景.有一天,市场部的同事来找你帮个小忙(有经

.Net WInform开发笔记(二)Winform程序运行结构图及TCP协议在Winform中的应用_C#教程

中午没事,把去年刚毕业那会画的几张图翻出来了,大概介绍Winform应用程序运行的过程,以及TCP协议在Winform中的应用.如果有Windows消息机制等基础,很好理解这两张图. (1)Winform应用程序运行结构图 开发笔记(二)Winform程序运行结构图及TCP协议在Winform中的应用_C#教程-tcp ip协议 层结构图"> (2)TCP通讯协议在Winform程序中的应用示意图 熟悉整个程序的来龙去脉,编程的时候就会很轻松,不会云里雾里. 另附公司招聘面试题一份,用了几

浅谈.NET下的多线程和并行计算(二)线程基本知识

首先来看看如何创建线程: Console.WriteLine(Process.GetCurrentProcess().Threads.Count); Thread t1 = new Thread(() => { Thread.Sleep(1000); Thread t = Thread.CurrentThread; Console.WriteLine("Name: " + t.Name); Console.WriteLine("ManagedThreadId: &quo

重走0到100的路,小程序路在何方?

微信之父张小龙这样描述小程序:小程序是一种不需要下载安装即可使用的应用,它实现了应用"触手可及"的梦想,用户扫一扫或者搜一下即可打开应用.体现了"用完即走"的理念,用户不用关心是否安装了太多的应用这样的问题.应用将无处不在,随时可用,但又无须安装和卸载. 2011年1月,微信诞生,从2011年2月到4月,微信用户的增长并不快,所有的平台加起来每天也就增长几千人,那时候很多人不看好这个项目,甚至各种关于抄袭的质疑声不断传出. 张小龙当时是这么回应的:在微信3.0版本的

程序员之路——一个老程序员对刚上大学的学弟学妹的忠告

始终认为,对一个初学者来说,IT界的技术风潮是不可追赶. 我时常看见自己的DDMM们把课本扔了,去买些价格不菲的诸如C#, VB.Net 这样的大部头,这让我感到非常痛心. 而许多搞不清指针是咋回事的BBS站友眉飞色舞的讨论C#里面可以不用指针等等则让我觉得好笑. C#就象当年的ASP 一样,"忽如一夜春风来,千树万树梨花开",结果许多学校的信息学院成了"Web 学院". 96, 97级的不少大学生都去做Web了.当然我没有任何歧视某一行业的意识. 我只是觉得如果他

九城生死路(二)危急关头的开源节流

上图简要的显示了九城关于07年第四季度到08年第四季度的财政收入变化.虽然魔兽世界在中国大陆运营之路坎坷不平,但这并不影响九城在收入上稳步提高.直到网易夺得了魔兽世界的运营权,当季九城收入下滑,08年的净利润直接比预期值低了72%. 截止到7月14日,九城股价1年内的变动范围为:最高28.50美元/股,最低8.53美元/股.周一收盘价为8.65美元/股,周二在 纳斯达克,该股跌31美分,以8.34美元/股报收,盘后交易中再跌5美分至8.29美元/股.九城股价创过去52周新低. 从28.5跌到8.