HOW TO:使用 Visual Basic .NET 生成 Office COM 外接程序
文章 ID | : | 302896 |
最后更新日期 | : | 2004年2月13日 |
版本 | : | 1.0 |
本文的发布号曾为 CHS302896
有关本文的 Microsoft Visual C# .NET 版本,请参阅
302901。
有关本文的 Microsoft Visual Basic 6.0 版本,请参阅
238228。
有关本文的 Microsoft Visual C++ 6.0 版本,请参阅
230689。
本任务的内容
• | 摘要
| ||||||||||||||||
• | 参考 |
概要
Microsoft Office 2000 和更高版本都支持一种新的统一的设计结构,这种结构用于生成应用程序外接程序以增强和控制 Office 应用程序。这些外接程序叫做 COM 外接程序。本文逐步讨论了 Office COM 外接程序并介绍了如何使用 Microsoft Visual Basic .NET 生成 Office COM 外接程序。
返回页首
返回页首
OnConnection 使用下列四个参数:
返回页首
OnDisconnection 使用下列两个参数:
返回页首
返回页首
由于在激发这些事件时宿主应用程序的用户界面是完全活动的,因此它们可能是执行某些操作的唯一途径,以其他途径将无法从 OnConnection 和 OnDisconnection 中执行这些操作。
返回页首
通常指定 0x03 (Connected | Bootload) 这一典型的值。
实现了 IDTExtensibility2 的外接程序还应指定一个名为 CommandLineSafe 的 DWORD 值,以指出外接程序对于不支持用户界面的操作是否安全。值为 0x00 表示 False,值为 0x01 则表示 True。
返回页首
要在 Visual Basic .NET 中创建 COM 外接程序,请按照下列步骤操作:
您可以选择完成所有这些步骤,还可以创建类型为
共享的外接程序的 NET 项目。这将启动“扩展性向导”,该向导可帮助您在 .NET 中创建 COM 外接程序。
“扩展性向导”将创建一个 Visual Basic .NET 类库项目,同时创建一个实现 IDTExtensibility2 接口的 Connect 类。它还会生成实现 IDTExtensibility 的空成员的主干代码。此项目具有对 Extensibility 和 Office 程序集的引用。该项目的生成设置中已选中了 注册 COM interop。将生成程序集密钥 (.snk) 文件,并在 Assemblyinfo.vb 文件的 AssemblyKeyfile 属性中进行引用。
除类库项目外,该向导还将生成一个安装项目,该项目可用于在其他计算机上部署 COM 外接程序。在需要时可以删除此项目。
返回页首
返回页首
返回页首
IDTExensibility2 接口
COM 外接程序是一种进程内 COM 服务器或 ActiveX 动态链接库 (DLL),它实现如 Microsoft 外接程序设计器类型库 (Msaddndr.dll) 中所描述的 IDTExensibility2 接口。所有 COM 外接程序都从此接口继承而来,而且都必须实现其五个方法中的每一个方法。返回页首
OnConnection
每当连接 COM 外接程序时,都会激发 OnConnection 事件。外接程序可以在启动时连接、由最终用户连接或者通过自动化来连接。如果 OnConnection 成功地返回,则表明已加载了外接程序。如果返回错误信息,那么宿主应用程序就立即释放其对该外接程序的引用,而且该对象将被销毁。OnConnection 使用下列四个参数:
• | Application — 一个对宿主应用程序对象的引用。 | ||||||||
• | ConnectMode — 一个指定外接程序连接方式的常量。外接程序可以采取下列几种方式连接:
| ||||||||
• | AddInInst — 一个对 COMAddIn 对象的引用,它引用宿主应用程序的 COMAddIns 集合中的此外接程序。 | ||||||||
• | Custom — 一个包含 Variant 类型值的数组,它可以存储用户定义的数据。 |
OnDisconnection
当 COM 外接程序断开连接并且在它从内存中卸载之前,将激发 OnDisconnection 事件。外接程序应在此事件中执行所有资源清理操作,并还原对宿主应用程序所做的任何更改。OnDisconnection 使用下列两个参数:
• | RemoveMode — 一个指定外接程序断开连接的方式的常量。外接程序可以采用下列方式断开连接:
| ||||
• | Custom — 一个包含 Variant 类型值的数组,它可以存储用户定义的数据。 |
OnAddInsUpdate
当注册的 COM 外接程序集发生变化时,将激发 OnAddInsUpdate 事件。换言之,每当安装 COM 外接程序或者从宿主应用程序中删除 COM 外接程序时,都会激发此事件。返回页首
OnStartupComplete 和 OnBeginShutdown
当宿主应用程序在忙于向内存中加载自身或者从内存中卸载自身时应避免用户交互,而 OnStartupComplete 和 OnBeginShutdown 方法都是在宿主应用程序已离开或正要进入这一状态时被调用的。只有在启动期间已连接了外接程序的情况下才调用 OnStartupComplete,只有宿主在关闭过程中要断开与外接程序的连接的情况下才调用 OnBeginShutdown。由于在激发这些事件时宿主应用程序的用户界面是完全活动的,因此它们可能是执行某些操作的唯一途径,以其他途径将无法从 OnConnection 和 OnDisconnection 中执行这些操作。
返回页首
COM 外接程序注册
除了正常的 COM 注册外,COM 外接程序还需要向其运行所在的每一个 Office 应用程序注册自身。为了向特定应用程序注册其自身,外接程序应使用其 ProgID 作为项名称在以下位置下创建一个子项:
HKEY_CURRENT_USER/Software/Microsoft/Office/OfficeApp/Addins/ProgID
外接程序可以在此项的位置为好记的显示名称和完整的说明提供值。此外,外接程序应使用一个名为 LoadBehavior 的 DWORD 值指定所希望的加载行为。此值确定宿主应用程序如何加载外接程序,而且它由下列值的组合组成:
• | 0 = Disconnect — 未加载。 |
• | 1 = Connected — 已加载。 |
• | 2 = Bootload — 在应用程序启动时加载。 |
• | 8 = DemandLoad — 只在由用户请求时加载。 |
• | 16 = ConnectFirstTime — 只加载一次(在下次启动时)。 |
实现了 IDTExtensibility2 的外接程序还应指定一个名为 CommandLineSafe 的 DWORD 值,以指出外接程序对于不支持用户界面的操作是否安全。值为 0x00 表示 False,值为 0x01 则表示 True。
返回页首
使用 Visual Basic .NET 生成 COM 外接程序
如上文所述,Office COM 外接程序是由 Office 应用程序通过 COM 运行时层激活的进程内 COM 服务器。因此,为了在 Visual Basic .NET 中开发 COM 外接程序,外接程序组件需要在 .NET 中实现,然后通过 COM interop 层向 COM 客户端(即 Office 应用程序)公开。要在 Visual Basic .NET 中创建 COM 外接程序,请按照下列步骤操作:
1. | 在 Visual Basic .NET 中,创建一个类库项目。 |
2. | 添加一个对实现 IDTExtensibility2 的类型库的引用。此项的主 interop 程序集已经出现在 Extensibility 名称下。 |
3. | 添加一个对 Microsoft Office 对象库的引用。此项的主 interop 程序集已经出现在 Office 名称下。 |
4. | 在实现 IDTExtensibility2 的类库中创建一个公共类。 |
5. | 生成该类库之后,将该库向 COM interop 进行注册。为此,需为此类库生成一个使用强名称的程序集,然后将它注册到 COM interop。可以使用 Regasm.exe 来向 COM interop 注册 .NET 组件。 |
6. | 创建注册表条目以使 Office 应用程序可以识别并加载外接程序。 |
“扩展性向导”将创建一个 Visual Basic .NET 类库项目,同时创建一个实现 IDTExtensibility2 接口的 Connect 类。它还会生成实现 IDTExtensibility 的空成员的主干代码。此项目具有对 Extensibility 和 Office 程序集的引用。该项目的生成设置中已选中了 注册 COM interop。将生成程序集密钥 (.snk) 文件,并在 Assemblyinfo.vb 文件的 AssemblyKeyfile 属性中进行引用。
除类库项目外,该向导还将生成一个安装项目,该项目可用于在其他计算机上部署 COM 外接程序。在需要时可以删除此项目。
返回页首
分步示例
1. | 在 Microsoft Visual Studio .NET 的文件菜单上,单击新建,然后单击项目。 | ||||||||||||||||||||
2. | 在新建项目对话框中,展开项目类型下的其他项目,选择扩展性项目,然后选择共享的外接程序模板。 | ||||||||||||||||||||
3. | 键入 MyCOMAddin 作为该外接程序的名称,然后单击确定。 | ||||||||||||||||||||
4. | “扩展性向导”出现后,请按照下列步骤操作:
| ||||||||||||||||||||
5. | 将以下成员添加到 Connect 类中:
| ||||||||||||||||||||
6. | 在 Connect 类中实现 IDTExtensibility2 的所有成员的代码,如下所示:
| ||||||||||||||||||||
7. | 生成并测试 COM 外接程序。为此,请按照下列步骤操作:
|
参考
有关编写 COM 外接程序的其他信息,请单击下面的文章编号,以查看 Microsoft 知识库中相应的文章:
返回页首
190253 INFO:VB6 Designers Do Not Work in VB5
有关为 Microsoft Internet Explorer 开发基于 Web 的解决方案的更多信息,请访问以下 Microsoft Web 站点:
http://msdn.microsoft.com/workshop/entry.asp
http://msdn.microsoft.com/ie/
http://support.microsoft.com/highlights/iep.asp?FR=0&SD=MSDN
(c) Microsoft Corporation 2001,保留所有权利。由 Microsoft Corporation 的 Ranjit R. Sawant 提供。
http://msdn.microsoft.com/ie/
http://support.microsoft.com/highlights/iep.asp?FR=0&SD=MSDN
返回页首
这篇文章中的信息适用于:
• | Microsoft Visual .NET 2002 标准版 |
• | Microsoft Office Excel 2003 |
• | Microsoft Excel 2002 标准版 |
• | Microsoft Office Outlook 2003 |
• | Microsoft Outlook 2002 标准版 |
• | Microsoft Office PowerPoint 2003 |
• | Microsoft PowerPoint 2002 标准版 |
• | Microsoft Office Word 2003 |
• | Microsoft Word 2002 标准版 |