Office 加载项代码示例

编写这些代码示例的目的是为了帮助你了解如何在开发 Office 加载项时使用各种功能。

入门

以下示例演示如何仅使用清单、HTML 网页和徽标生成最简单的 Office 加载项。 这些组件是 Office 加载项的基本部分。 有关其他入门信息,请参阅我们的 快速入门教程

Blazor WebAssembly

如果你的开发背景是在生成 VSTO 外接程序,则以下示例演示如何使用 .NET Blazor WebAssembly 生成 Office Web 外接程序。 可以在 C# 和 Visual Studio 中保留大部分代码。

Excel

名称 说明
数据类型资源管理器 (预览) 生成一个 Excel 加载项,用于创建和浏览工作簿中的数据类型。 数据类型使外接程序开发人员能够将复杂的数据结构组织为对象,例如格式化的数字值、Web 图像和实体值。
在 Teams 中打开 在 Microsoft Teams 中新建包含你定义的数据的 Excel 电子表格。
插入外部 Excel 文件并使用 JSON 数据填充 将外部 Excel 文件中的现有模板插入当前打开的 Excel 工作簿。 然后,使用来自 JSON Web 服务的数据填充模板。
在功能区上创建自定义上下文选项卡 在 Office UI 中的功能区上创建自定义上下文选项卡。 该示例创建一个表,并且当用户将焦点移动到表内时,将显示自定义选项卡。 当用户移出表外时,自定义选项卡将隐藏。
使用键盘快捷方式执行 Office 加载项操作 设置使用键盘快捷方式的基本 Excel 加载项项目。
使用 Web 辅助进程的自定义函数示例 在自定义函数中使用 Web 辅助进程来防止阻止 Office 加载项的 UI。
脱机时使用存储技术从 Office 加载项访问数据 实施 localStorage,以便在用户遇到连接丢失时为 Office 加载项启用有限的功能。
自定义函数批处理模式 将多个调用批处理为单个调用,以减少对远程服务的网络调用数。

Outlook

名称 说明
在 Outlook 中报告垃圾邮件或钓鱼电子邮件 展示如何构建可在 Outlook 客户端功能区中轻松发现的集成垃圾邮件报告解决方案。 为用户提供用于报告电子邮件的处理对话框。 有助于将报告的电子邮件副本保存到文件,以便将其提交到后端系统以供进一步处理。
使用 Outlook 基于事件的激活来加密附件、处理会议请求与会者并响应约会日期/时间更改 当由用户添加时,使用基于事件的激活来加密附件。 此外,对会议请求中更改的收件人,以及会议请求中开始或结束日期或时间的更改使用事件处理。
使用 Outlook 基于事件的激活识别和标记外部收件人 当用户在撰写邮件时更改收件人时,使用基于事件的激活运行 Outlook 加载项。 加载项还使用 appendOnSendAsync API 添加免责声明。
使用 Outlook 基于事件的激活设置签名 用户创建新邮件或约会时,基于事件的激活将运行 Outlook 加载项。 即使任务窗格未打开,外接程序也可以响应事件。 它还使用 setSignatureAsync API。
使用智能警报发送邮件或约会之前验证其颜色类别 在发送新邮件或约会之前,使用 Outlook 智能警报验证是否已将所需的颜色类别应用到新邮件或约会。
验证消息的敏感度标签 在基于事件的外接程序中使用敏感度标签 API 来验证 高度机密 敏感度标签并将其应用于适用的传出消息。
在 Outlook (预览版中报告垃圾邮件或钓鱼电子邮件) 生成一个集成的垃圾邮件报告加载项,该加载项显示在 Outlook 功能区上的醒目的位置。

Word

名称 说明
使用 Word 加载项获取、编辑和设置 Word 文档中的 OOXML 内容 此示例展示了如何获取、编辑和设置 Word 文档中的 OOXML 内容。 示例加载项提供了一个暂存区,用于获取自己的内容的 Office Open XML,并测试自己编辑的 Office Open XML 代码片段。
使用Word加载项导入Word文档模板 演示如何在Word文档中导入模板。
在 Word 加载项中加载和写入 Open XML 本示例加载项显示如何通过将 setSelectedDataAsync 方法与 ooxml coercion 类型结合使用,将多种丰富的内容类型添加到 Word 文档。 还可以通过此加载项直接在页面上显示每个示例内容类型的 Office Open XML 标记。
使用Word加载项管理引文 演示如何管理Word文档中的引文。

身份验证、授权和单一登录 (SSO)

名称 说明
示例名称 Description
---------------- --------------------------------------------------------
使用嵌套应用身份验证进行 SSO 的 Office 外接程序 演示如何在 Office 外接程序中使用 MSAL.js 嵌套应用身份验证 (NAA) 来访问已登录用户的 Microsoft Graph API。 该示例显示已登录用户的姓名和电子邮件。 它还会将用户的 Microsoft OneDrive 帐户中的文件名插入到文档中。
使用嵌套应用身份验证使用 SSO 的 Outlook 外接程序 演示如何在 Outlook 外接程序中使用 MSAL.js 嵌套应用身份验证 (NAA) 来访问已登录用户的 Microsoft Graph API。 该示例显示已登录用户的姓名和电子邮件。 它还会将用户的 Microsoft OneDrive 帐户中的文件名插入到新的邮件正文中。
在 Outlook 外接程序中将 SSO 与基于事件的激活配合使用 演示如何使用 SSO 从 Outlook 外接程序中触发的事件访问用户的 Microsoft Graph 数据。
单一登录 (SSO) 示例 Outlook 加载项 使用 Office 的 SSO 功能向加载项提供 Microsoft Graph 数据的访问权限。
使用 Microsoft Graph 和 Office 加载项中的 msal.js 获取 OneDrive 数据 将 Office 加载项构建为一个没有后端的单页应用程序 (SPA),该应用程序连接到 Microsoft Graph,并访问存储在 OneDrive for Business 中的工作簿以更新电子表格。
Office 加载项对 Microsoft Graph 的身份验证 了解如何构建连接到 Microsoft Graph 的 Microsoft Office 加载项,并访问存储在 OneDrive for Business 中工作簿以更新电子表格。。
Outlook 加载项对 Microsoft Graph 的身份验证 生成连接到 Microsoft Graph 的 Outlook 加载项,并访问存储在 OneDrive for Busines s中的工作簿以撰写新的电子邮件。
带有 ASP.NET 的单一登录 (SSO) Office 加载项 在 Office.js 中使用 getAccessToken API 为加载项提供对 Microsoft Graph 数据的访问权限。 此示例基于 ASP.NET。
带有 Node.js 的单一登录 (SSO) Office 加载项 在 Office.js 中使用 getAccessToken API 为加载项提供对 Microsoft Graph 数据的访问权限。 此示例基于 Node.js 构建。

Office

名称 说明
在 Office 外接程序中保存自定义设置 在 Office 外接程序中保存自定义设置。 外接程序将数据存储为键值对,使用适用于 Office 的 JavaScript API 属性包、浏览器 Cookie、web 存储 (localStorage 和 sessionStorage) ,或者将数据存储在文档中的隐藏 div 中。

共享运行时

名称 说明
与共享运行时共享全局数据 设置使用共享运行时在单个浏览器运行时中运行功能区按钮、任务窗格和自定义函数代码的基本项目。
管理功能区和任务窗格 UI,并在打开文档时运行代码 创建根据加载项状态启用的上下文功能区按钮。

其他示例

名称 说明
使用共享库将 Visual Studio Tools for Office 加载项迁移到 Office Web 加载项 提供从 VSTO 加载项迁移到 Office 加载项时代码重用的策略。
将 Azure 函数与 Excel 自定义函数集成 将 Azure Functions 与自定义函数集成,以移动到云或集成其他服务。
动态 DPI 代码示例 用于处理 COM、VSTO 和 Office 加载项中 DPI 更改的示例集合。

后续步骤

加入 Microsoft 365 开发人员计划 以获取资源和信息,帮助你为 Microsoft 365 平台构建解决方案,包括针对你感兴趣的领域定制的建议。

你可能还有资格获得免费开发人员订阅,该订阅可续订 90 天,并附带示例数据;有关详细信息,请参阅 常见问题解答