演练:创建您的第一个 Excel 应用程序级外接程序
本介绍性演练演示如何创建 Microsoft Office Excel 的应用程序级外接程序。 您在此类解决方案中创建的功能可用于应用程序本身,而与所打开的工作簿无关。
**适用于:**本主题中的信息适用于 Excel 2007 和 Excel 2010 的应用程序级项目。有关更多信息,请参见按 Office 应用程序和项目类型提供的功能。
本演练阐释了以下任务:
创建 Excel 的 Excel 外接程序项目。
编写代码,使用 Excel 对象模型在保存工作簿后向工作簿中添加文本。
生成并运行此项目以对它进行测试。
清理已完成的项目,使该外接程序在开发计算机上不再自动运行。
提示
对于在以下说明中使用的某些 Visual Studio 用户界面元素,您的计算机可能会显示不同的名称或位置。这些元素取决于您所使用的 Visual Studio 版本和您所使用的设置。有关更多信息,请参见 Visual Studio 设置。
系统必备
您需要以下组件来完成本演练:
-
Visual Studio 2010 的一个版本,其中包含 Microsoft Office 开发工具。有关更多信息,请参见[将计算机配置为开发 Office 解决方案](bb398242\(v=vs.100\).md)。
- Microsoft Office Excel 2007 或 Excel 2010。
创建项目
在 Visual Studio 中创建新的 Excel 外接程序项目
启动 Visual Studio。
在**“文件”菜单上指向“新建”,再单击“项目”**。
在“模板”窗格中,展开**“Visual C#”或“Visual Basic”,然后展开“Office”**。
在展开的**“Office”节点下,选择“2007”(如果已安装 Excel 2007)或选择“2010”**节点(如果已安装 Excel 2010)。
在项目模板列表中,选择**“Excel 2007 外接程序”或“Excel 2010 外接程序”**。
在**“名称”**框中键入 FirstExcelAddIn。
单击**“确定”**。
Visual Studio 即会创建 FirstExcelAddIn 项目,并在编辑器中打开 ThisAddIn 代码文件。
编写用于向保存的工作簿中添加文本的代码
接下来,将代码添加到 ThisAddIn 代码文件中。 新代码使用 Excel 的对象模型将样本文本插入到活动工作表的首行中。 活动工作表是当用户保存工作簿时处于打开状态的工作表。 默认情况下,ThisAddIn 代码文件包含所生成的以下代码:
ThisAddIn 类的分部定义。 此类提供了代码的入口点,并提供了对 Excel 对象模型的访问。 有关更多信息,请参见应用程序级外接程序编程。 ThisAddIn 类的其余部分是在一个隐藏的代码文件中定义的,您不应修改此代码文件。
ThisAddIn_Startup 和 ThisAddIn_Shutdown 事件处理程序。 当 Excel 加载和卸载外接程序时会调用这些事件处理程序。 使用这些事件处理程序,可在加载外接程序时对外接程序进行初始化,并在卸载外接程序时清理外接程序所使用的资源。 有关更多信息,请参见 Office 项目中的事件。
向保存的工作簿中添加一行文本
在 ThisAddIn 代码文件中,将下面的代码添加到 ThisAddIn 类中。 新代码定义 WorkbookBeforeSave 事件的事件处理程序,该事件在保存工作簿时引发。
用户保存工作簿时,该事件处理程序会将新文本添加到活动工作簿的开头。
Private Sub Application_WorkbookBeforeSave(ByVal Wb As Microsoft.Office.Interop.Excel.Workbook, ByVal SaveAsUI As Boolean, ByRef Cancel As Boolean) Handles Application.WorkbookBeforeSave Dim activeWorksheet As Excel.Worksheet = CType(Application.ActiveSheet, Excel.Worksheet) Dim firstRow As Excel.Range = activeWorksheet.Range("A1") firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown) Dim newFirstRow As Excel.Range = activeWorksheet.Range("A1") newFirstRow.Value2 = "This text was added by using code" End Sub
void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI, ref bool Cancel) { Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet); Excel.Range firstRow = activeWorksheet.get_Range("A1", missing); firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown, System.Type.Missing); Excel.Range newFirstRow = activeWorksheet.get_Range("A1", missing); newFirstRow.Value2 = "This text was added by using code"; }
如果您使用的是 C#,请将以下必需代码添加到 ThisAddIn_Startup 事件处理程序中。 此代码用于将 Application_WorkbookBeforeSave 事件处理程序与 WorkbookBeforeSave 事件连接起来。
this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);
为了在保存工作簿后对其进行修改,前面的代码示例使用了以下对象:
ThisAddIn 类的 Application 字段。 Application 字段返回一个 Microsoft.Office.Interop.Excel.Application 对象,该对象表示 Excel 的当前实例。
WorkbookBeforeSave 事件的事件处理程序的 Wb 参数。 Wb 参数是一个 Microsoft.Office.Interop.Excel.Workbook 对象,用于表示已保存的工作簿。 有关更多信息,请参见 Excel 对象模型概述。
测试项目
测试项目
按**“F5”**生成并运行项目。
生成项目时,代码会编译成一个程序集,此程序集包含在项目的生成输出文件夹中。 Visual Studio 还会创建一组注册表项,通过这些注册表项,Excel 能够发现和加载此外接程序;Visual Studio 还将开发计算机上的安全设置配置为允许此外接程序运行。 有关更多信息,请参见 Office 解决方案生成过程概述。
在 Excel 中,保存工作簿。
验证下面的文本是否已添加到工作簿中。
This text was added by using code.
关闭 Excel。
清理项目
完成项目的开发后,请从开发计算机上移除外接程序程序集、注册表项和安全设置。 否则,每次在开发计算机上打开 Excel 时,此外接程序都将继续运行。
在开发计算机上清理已完成的项目
- 在 Visual Studio 的**“生成”菜单中,单击“清理解决方案”**。
后续步骤
既然您已经创建了一个基本的 Excel 应用程序级外接程序,就可以从下面这些主题中了解有关如何开发外接程序的更多内容了:
您可以在外接程序中执行的常规编程任务:应用程序级外接程序编程。
特定于 Excel 外接程序的编程任务:Excel 解决方案。
使用 Excel 对象模型:Excel 对象模型概述。
自定义 Excel 的用户界面 (UI),例如,向功能区添加自定义选项卡或创建自己的自定义任务窗格:Office UI 自定义。
生成和调试 Excel 的应用程序级外接程序:生成和调试 Office 解决方案。
部署 Excel 的应用程序级外接程序:部署 Office 解决方案。