创建Excel解决专项方案.doc

VSTO之旅系列(二)：创立Excel解决方案
-02-24 18:00:15
0

本专项概要
· 引言
· 创立VSTO项目
· Excel对象模型
· 创立Excel外接程序
· 创立Excel文档级自定义项
· 小结

一、引言
　　也许诸多朋友都没有据说过VSTO这个东西，本人之前也同样也不懂得，但是由于工作因素接触了这方面，由于VSTO方面国内资料比较少，本人刚开始学习时候都是参照MSDN，但是上面诸多资料都是英文，也许学习起来会比较慢点，因此本人把近来一段时间学习内容记录下来，一来是作为一种巩固学习笔记，二来但愿这些博客可以协助某些刚接触VSTO朋友可以有所借鉴。
　　讲了这样多废话(指上面某些过渡话)，究竟VSTO究竟是什么呢?这里我简朴概括下——VSTO是微软推出一种对Office产品进行操作技术，其中提供了某些类库来让开发人员可以更以便地开发出Office解决方案,即对Word/Excel/Outlook实现某些扩展功能。  对于VSTO更多简介人们可以参看该系列第一篇博文。在这个专项将为人们简介下，如何创立Excel解决方案?
二、创立VSTO项目
对于刚接触VSTO朋友来说，也许主线就不懂得如何去创立一种VSTO项目，相信通过这个某些人们就会觉得是如此简朴。
环境搭建
进行VSTO开发环境搭建是相称简朴，只需要安装Visual Studio (固然安装VS时候在安装组件中必要勾选VSTO选取，这个选项是默认勾上。人们可以在安装VS时候留意下)和Office 就可以，固然VS 和Office 安装也可以完毕环境搭建。
创立第一种Excel工程来开始咱们VSTO之旅
第一步， 选取新建项目->Visual C#->Office->，然后选取Excel 外接程序(如何是英文版即Excel Add-in)，如下图：

　　从图中可以看到，除了外接程序外，尚有Excel模板和Excel文档这两种项目类型，她们区别是 外接程序是应用程序级别，即如果你创立了Excel 外接程序，该程序对所有Excel应用都是有效，由于每次Excel启动过程都会加载该插件(即该程序)，人们必定留意到当咱们启动Excel或Word时候都会加载某些加载项，其实这些加载项就是属于外接程序，即插件，启动过程见下面图：

　　而 文档和模板项目，都是属于文档级别程序，该程序只对当前文档和模板有效，创立这两种类型项目，会在项目工程目录下会生成一种word文献(文档项目会生成一种 Document1.docx文献，模板项目会生成一种Document1.dotx文献)。
创立成功之后，外接程序项目文献构造见下图：

　　从图中可以看出，刚创立VSTO外接程序都只有一种ThisAddIn.cs文献，该文献即是一种宿主项(更多关于宿主项和宿主控件内容可以查看该系列第一篇博文)，咱们可以通过这个文献来对Excel对象进行访问。同步该类中有ThisAddIn_Startup和ThisAddIn_Shutdown两个办法，从两个办法中命名中可以懂得，如果你代码想在加载外接程序时运营话，就放把代码放在ThisAddIn_Startup办法内容，如果你想在外接程序卸载时候运营你代码，就把这些代码放在ThisAddIn_Shutdown办法内。
三、Excel对象模型
 要开发Excel项目，就自然少不了对Excel对象模型理解了，只有理解Excel对象模型，这样才干更好地对Excel进行解决。下面先给出一张Excel对象模型图：

 下面就详细对上图中各个对象做一种简朴简介：
Application对象——Excel中Application对象表达Excel应用程序，该对象是所有Excel对象根，你可以通过Application对象，获取到其她对象，在外接程序中，咱们可以通过下面方式来获得Application对象：Globals.ThisAddIn.Application
Workbooks对象代表Workbook对象集合，而Workbook对象表达Excel中单个工作簿，咱们可以通过下面方式来获得工作簿对象：Globals.ThisAddIn.Application.ThisWorkbook
Worksheets对象代表Worksheet对象集合，而Worksheet代表就是Excel中表，下面代码可以获得Worksheet对象：Globals.ThisAddIn.Application.ThisWorkbook.ActiveSheet (激活表，每次打开一种Excel文献，都是表一即sheet1被激活，因此通过该代码就说获得表一对象)
Range对象代表一种范畴，是操作Excel文档最惯用对象，它可以表达为一种单元格、一行、一列或各种单元格块（可以持续，也可以不持续）单元格选定范畴，甚至各种工作表中一组单元格。也许上面解释过于枯燥，相信人们通过下图可以更好地理解Excel中各个对象：

四、创立Excel外接程序
简介完了Excel对象模型之后，咱们就可以运用这些对象来对Excel文档进行操作了，下面就创立一种简朴Excel外接程序。
一方面咱们模仿一种需求，大多说软件在使用时都会弹出一种欢迎界面，这样咱们就创立一种外接程序，每次打开Excel文献时弹出一种欢迎界面,退出时弹出“谢谢使用”界面。
 咱们只需要在上面创立工程中介入下面代码即可：
using System.Windows.Forms;namespace MyExcelAddIn1{ public partial class ThisAddIn { private void ThisAddIn_Startup(object sender，System.EventArgs e) { // 由于欢迎使用窗口要在打开Excel时候弹出，因此把下面代码放在Startup办法内 MessageBox.Show("欢迎使用Microsoft Excel")； } private void ThisAddIn_Shutdown(object sender，System.EventArgs e) { // 在退出Excel时候弹出谢谢使用窗口，因此把下面代码放在Shutdown办法内 MessageBox.Show("谢谢使用！")； } #region VSTO generated code /// <summary> /// Required method for Designer support - do not modify /// the contents of this method with the code editor. /// </summary> private void InternalStartup() { this.Startup += new System.EventHandler(ThisAddIn_Startup)； this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown)； } #endregion }}

这样，咱们就完毕了上面简朴一种模仿需求了，下面让咱们按F5来测试下效果吧！
按F5运营该程序时，一方面打开一种Excel之后，一种欢迎界面就会弹出：

点击Excel窗口上"X"按钮时，就会弹出一种 “谢谢使用！”窗口，效果如下：

点击 Ok 按钮之后才会正常退出Excel。这样就完毕了一种简朴Excel外接程序了，上面提到过外接程序是应用程序级别，因此当你每次打开Excel时候都会有这样一种欢迎界面和关闭Excel时均有一种"谢谢使用"窗口,有些朋友想问了，如果我想卸载这个插件怎么办呢？办法很简朴，只需要右键你解决方案——>清理，这样可以了，此外你也可以从开发工具选项卡——>COM 插件，在弹出窗口中选取你自定义插件 再按下移除按钮。详细环节见下图：

五、创立Excel文档级自定义项
简介完了创立Excel外接程序之后，下面看看如何创立一种文档级项目：
1. 新建一种Excel Workbook(即Excel工作簿)项目：

2. 单击 OK按钮，在下面窗口中单击 ”OK“按钮：

3. 在第一创立Excel工作簿项目是会弹出下面一种窗口（窗口意思为：与否容许创立项目访问VBA项目系统），此时咱们只需要点击“Ok”就完毕了Excel工作簿项目创立。

 当前咱们来模仿一种需求，例如当前有一种成绩单工作表，咱们但愿获得各科目不及格同窗名字。此时咱们只需要在上面创立工作簿项目中添加一种ComboBox，一种Button，一种textbox。在buttonClick事件中添加下面代码：
// 找出各科目不及格同窗名字 private void btnSearch_Click(object sender，EventArgs e) { // 清除textbox中内容 txtResult.Clear()； // 从复选框中获得选取科目索引 int subjectIndex = cbxsubjects.SelectedIndex； if (subjectIndex == -1) { MessageBox.Show("请先选取一种科目")； return； } // 获得选取科目名称 string subjectName = cbxsubjects.SelectedItem.ToString()； // 获得工作表对象 Excel.Worksheet worksheet =(Excel.Worksheet)Globals.ThisWorkbook.ActiveSheet； for (int row = 2；row < worksheet.UsedRange.Rows.Count+1；row++) { Excel.Range rng =(Excel.Range)worksheet.Cells[row,subjectIndex + 2]； Excel.Range rng1 = (Excel.Range)worksheet.Cells[row，1]； if (rng.Value< 60) { txtResult.Text += rng1.Value + "；"； } } if (txtResult.Text.Length == 0) { txtResult.Text = subjectName + "没有不及格同窗"； } }

运营该项目成果为：

六、小结
　　到这里本专项简介就结束了， 本专项一方面重要简介了Excel对象模型和如何创立Excel两种项目类型，但愿通过本专项人们可以开发出某些简朴Excel解决方案，背面一种专项将为人们简介如何为Excel自定义一种选项卡和上下文菜单。
专项源码： 

VSTO之旅系列(三)：自定义Excel UI
-03-04 01:00:17
0

本专项概要
· 引言
· 自定义任务窗体(Task Pane)
· 自定义选项卡，即Ribbon
· 自定义上下文菜单
· 小结

引言
　　在上一种专项中为人们简介如何创立Excel解决方案,相信人们通过从上面一种专项之后理解了Excel对象模型，以及Office两种解决方案，看完上一种专项之后，必定诸多朋友想为Excel自定义属于自己UI界面，例如，有这样某些疑问——与否可以使用VSTO来自定义选项卡呢？ 与否可以自定义上下文菜单呢？如果你也有这些疑问话，相信通过本专项你将会得到答案，下面就开始咱们本专项简介。
二、自定义任务窗体
 　　在使用Word时候咱们可以通过左边导航来看理解文档构造，同步咱们也可以在输入框地方输入文字来进行搜索，然而这个左边导航就是一种任务窗体，相信通过下面图人们可以理解Word中那某些是一种任务窗体：

　　但是咱们在使用Excel中却没有找到类似任务窗体，这时候人们必定会有这样一种疑问——如果我想在Excel也想实现一种自定义任务窗体该怎么办呢？用VSTO可以帮咱们办到吗？答案是必定。一方面先模仿一种需求，相信人们都懂得使用F1是打开一种协助文档，但是弹出协助文档是与Excel在不同界面，因此诸多朋友在查阅协助文档时候都需要缩小Excel文档来查阅，这样就显得有些不以便了，我在使用时候就想，能不能把协助文档继承在Excel右边呢？这样咱们查阅Excel协助文档就以便多了，就不要缩小Excel文档，或在Excel和协助文档之间左右切换了。既然有这种需求，咱们就有实现它必要性，下面就详细说说如何实现：
一方面在看详细代码之前，我向人们分析下实现一种任务窗体思路：
· 一方面，任务窗体是一种窗体，固然就需要在创立Excel解决方案中创立一种窗体了，这里咱们创立了一种顾客控件。
· 创立和设计完顾客控件界面之后，咱们就需要把这个顾客控件添加到Excel中去了，然而咱们在此前接触开发中，添加控件都是把控件添加到某个几种中去，例如WinForm中要向窗体添加一种button按钮，就需要把这个button添加进Controls集合中，同样VSTO也提供这样一种把任务面板添加进去集合—— Microsoft.Office.Tools.CustomTaskPaneCollection，咱们可以通过 Globals.ThisAddIn.CustomTaskPanes这行代码来获得这个集合，然后调用Add办法就可以把咱们自定义任务面板添加进Excel中了。
· 添加进去之后，咱们还需要使任务面板显示出来，这样就涉及了Visible属性了，的确 Microsoft.Office.Tools.CustomTaskPane 也有Visible属性
　　有了上面分析过程之后，相信人们看下面代码会比较容易理解，此外注意一点是，由于咱们要实现协助文档任务窗体，由于协助文档是在浏览器中显示，这样咱们就需要集成一种浏览器到咱们创立顾客控件中，人们看到浏览器这个词可千万不要觉得有所畏惧，由于微软提供了WebBrowser控件来协助咱们实现，对于浏览器更多内容可以参看我这篇博客：自定义Web浏览器， 自定义任务窗体代码如下：
public partial class ThisAddIn { // 定义一种任务窗体 internal Microsoft.Office.Tools.CustomTaskPane helpTaskPane； private void ThisAddIn_Startup(object sender，System.EventArgs e) { // 把自定义窗体添加到CustomTaskPanes集合中 // ExcelHelp 是一种自定义控件类 helpTaskPane = Globals.ThisAddIn.CustomTaskPanes.Add(new ExcelHelp("")，"Excel Help")； // 使任务窗体可见 helpTaskPane.Visible = true； // 通过DockPosition属性来控制任务窗体停靠位置， // 设立为 MsoCTPDockPosition.msoCTPDockPositionRight这个代表停靠到右边，这个值也是默认值 //helpTaskPane.DockPosition = MsoCTPDockPosition.msoCTPDockPositionRight； } private void ThisAddIn_Shutdown(object sender，System.EventArgs e) { } }

三、自定义选项卡，即Ribbon
 上面实现任务窗体在Excel一打开时候就会显示停靠在Excel右边，如下图所示：

　　然而当咱们点击任务窗体中"X"按钮就是关闭任务窗体，关闭之后就有一种问题，如果咱们又想把协助任务窗体显示出来怎么办呢？由于在Word中导航窗体也不是一开始就显示(有些朋友也许打开Word文档没有导航窗体)，此时咱们通过勾选视图选项卡中 “导航窗格”或点击开始选项卡中查找按钮来显示导航窗体：

此时，咱们就想在Excel中与否可以自定义一种选项卡，通过选项卡中按钮来显示/隐藏 Excel协助任务窗体呢？下面就详细简介如何创立一种自定义选项卡：
1. 右键你Excel项目，添加—>新建项，在弹出添加新项窗口中选取 "功能区(可视化设计器)" 
2. 输入名称之后单击添加按钮
3. 设计选项卡UI界面，本例子中添加了一种toggleButton.
通过上面环节就可以创立一种自定义选项卡，这种方式创立选项卡在Excel项目(针对是外接Excel项目类型)启动时候就会被加载。
下面详细简介了如何设计选项卡(即Ribbon)：
1. 设计RibbonTab，一方面把ControlIdType属性设立为Custom，否则咱们设计RibbonGroup某些将会在加载项选项卡下，然后设立Name为HelpTab,这样咱们创立选项卡才会成为一种新选项卡，如果咱们想把ToggleButton放在Home选项卡下显示，此时咱们只需要把ControlIdType设立为Office，然后把OfficeId设立为TabHome，详细状况人们可以测试看看，关于Office 中内置Control ID 列表，人们可以从下面这个链接下载：  
Office System Document：Lists of Control IDs 

　　2. 从工具箱中拖出一种ToggleButton，把Label属性设立为Help，并把ControlSize属性设立为RibbonControlSizeLarge：

　　3. 双击 Help ToggleButton按钮，实现它单击事件：
// 协助选项卡中toggleButton单击事件 private void toggleHelpBtn_Click(object sender，RibbonControlEventArgs e) { // 通过toggleHelpButton选中状态来控制协助任务栏显示和隐藏 Globals.ThisAddIn.helpTaskPane.Visible = toggleHelpBtn.Checked； }

　　通过上面三步也就完毕了一种Ribbon创立了，当咱们创立好一种Ribbon之后，咱们可以通过咱们自定义Ribbon下按钮来显示/隐藏咱们任务窗体，但是到这里，Ribbon开发并没有结束，此时尚有一种问题就是——当咱们点击 “Excel help”右上角X按钮关闭时，咱们Ribbon下按钮状态也要跟着更变(人们可以测试，当咱们关闭Word中导航任务窗体时，试图下"导航窗格"复选框“也会跟着变化)，此时咱们就需要实现：点击关闭按钮与Help按钮状态同步功能，此时咱们只需要对TaskPaneVisibleChanged事件进行解决就可以（由于关闭任务窗体就会触发该事件，因此只需要把同步状态代码放在该事件就可以了),详细代码如下：
// 定义一种任务窗体 internal Microsoft.Office.Tools.CustomTaskPane helpTaskPane； private void ThisAddIn_Startup(object sender，System.EventArgs e) { // 把自定义窗体添加到CustomTaskPanes集合中 // ExcelHelp 是一种自定义控件类 helpTaskPane = Globals.ThisAddIn.CustomTaskPanes.Add(new ExcelHelp("")，"Excel Help")； // 使任务窗体可见 //helpTaskPane.Visible = true； // 通过DockPosition属性来控制任务窗体停靠位置， // 设立为 MsoCTPDockPosition.msoCTPDockPositionRight这个代表停靠到右边，这个值也是默认值 //helpTaskPane.DockPosition = MsoCTPDockPosition.msoCTPDockPositionRight； // 当顾客点击 “Excel help”右上角X按钮关闭时，咱们需要同步选项卡上button状态 helpTaskPane.VisibleChanged += new EventHandler(helpTaskPane_VisibleChanged)； // 添加上下文菜单 //AddToCellMenu()； } private void ThisAddIn_Shutdown(object sender，System.EventArgs e) { } // 顾客点击 "Excel Help" 侧边栏右上角X按钮关闭它时 // 咱们需要对的同步 “协助”按钮状态 // 咱们可以通过解决 “Excel Help”侧边栏VisualChanged 事件完毕 private void helpTaskPane_VisibleChanged(object sender，EventArgs e) { // 获得Help Ribbon 对象 Help helpRibbon = Globals.Ribbons.GetRibbon<Help>()； // 同步Help Ribbon下"协助"按钮状态 helpRibbon.toggleHelpBtn.Checked = Globals.ThisAddIn.helpTaskPane.Visible； }

运营效果图为：

四、自定义上下文菜单
 看完上面两某些实现之后，我在学习过程中又想——能不能通过右键菜单来显示/隐藏任务窗体呢?对于这点VSTO也是可以做到，咱们只需要添加CommandBarButton对象（当咱们右键一种单元格(即为Cell)时候,咱们可以看到一上下文菜单，菜单内所有控件(不论是按钮还是排序这样菜单控件)），然后设立该对象属性和添加一种Click事件，重要代码如下：
// 添加一种自定义按钮到单元格上下文菜单中 contextMenu =Application.CommandBars["Cell"]； CommandBarButton commandBarbtn = (CommandBarButton)contextMenu.Controls.Add(MsoControlType.msoControlButton，Before：1)； commandBarbtn.Tag = "Help_Tag"； commandBarbtn.Caption = "查看协助"； commandBarbtn.FaceId = 49； commandBarbtn.Click+=new _CommandBarButtonEvents_ClickEventHandler(commandBarbtn_Click)；

运营效果为(这样咱们右键Cell时候就会多余一种咱们自己定义 ”查看协助“按钮)：

五、小结
　　到这里本专项内容就简介完了，本专项重要简介如何为Excel创立一种自定义任务窗体、Ribbon和上下文菜单，对于Word和Outlook这某些内容我就不重复简介，创立方式和Excel创立方式很类似。在下一种专项中我将给人们简介下如何创立Word解决方案。
本专项所有源码：