用于开发 Microsoft 365 应用和代理(包括 Office 加载项)的主要工具是 Microsoft 365 代理工具包。
使用代理工具包创建的加载项使用 Microsoft 365 的统一清单。
注意
有关支持使用 Microsoft 365 统一清单的 Office 加载项的客户端和平台的信息,请参阅 具有 Microsoft 365 统一应用清单的 Office 加载项。
将最新版本的 Agents Toolkit 安装到 Visual Studio Code 中,如安装 Microsoft 365 Agents Toolkit 中所述。
创建 Office 加载项项目
打开 Visual Studio Code,然后选择“活动栏”中的“代理工具包”图标。
选择“ 新建应用”。
此时将打开 “新建项目” 下拉菜单。 列出的选项将因 Agents Toolkit 版本而异。 选择 “Office 加载项”。
此时将打开 “使用 Office 加载项的应用功能” 下拉菜单。 列出的选项将因 Agents Toolkit 版本而异。 选择 “任务窗格”。
此时将打开列出要支持的 Office 应用程序的下拉菜单。 选择要在其中运行加载项的一个或多个应用程序。
在打开的 “工作区文件夹 ”对话框中,选择要在其中创建项目的文件夹。
为项目 (命名,提示时不) 空格。 Agents Toolkit 将使用基本文件和基架创建项目。 然后,它将在第二个 Visual Studio Code 窗口中打开项目。 关闭原始 Visual Studio Code 窗口。
注意
生成的项目配置为可安装在之前所选的 Office 应用程序上。 你可以根据需要编辑清单和源文件,以更改支持的 Office 应用程序。
在 Visual Studio Code TERMINAL 中,导航到项目的根目录并运行
npm install。安装完成后,验证是否可以从 Visual Studio Code 旁加载加载项。 旁加载的步骤因要测试加载项的 Office 应用程序而异。
在 Excel、PowerPoint 或 Word 中旁加载
注意
仅当在 Windows 计算机上开发加载项时,本部分才适用。
选择“在Visual Studio Code 中查看 | 运行”。 在 RUN AND DEBUG 下拉菜单中,选择以下选项之一:
- Excel 桌面版 (Edge Chromium)
- PowerPoint 桌面版 (Edge Chromium)
- Word桌面 (Edge Chromium)
按 F5。 项目生成,并打开“节点开发服务器”窗口。 此过程可能需要几分钟。 最终,将打开所选 Office 应用程序的桌面版本。
注意
如果这是你第一次在计算机 (上旁加载 Office 加载项,或者是一个多月) 来的第一次,系统可能会提示你删除旧证书和/或安装新证书。 同意这两个提示。
主页功能区上将显示一个带有两个按钮的 Contoso 加载项选项卡。 使用一个按钮在打开的 Office 文档中执行操作。 使用另一个打开加载项的任务窗格。
注意
无论选择哪个按钮,都会出现 WebView 加载时停止 提示。 选择“确定”。
提示
Windows 版 Office 中的旁加载还使加载项在 Office web 版中可用,因此你也可以在该平台上对其进行测试。 完成此步骤后,最小化 Office on Windows 应用程序窗口,在浏览器中导航到
https://excel.cloud.microsoft/、https://word.cloud.microsoft/或https://powerpoint.cloud.microsoft/,以适合正在测试的加载项为准。 在 Web 上的 Office 应用程序中打开一个新文档或现有文档。 这些按钮应显示 在主功能 区上,就像它们在 Windows 上的 Office 中一样。若要停止调试并卸载加载项,请选择“在 Visual Studio Code 中运行 | 停止调试”。
注意
如果上述步骤似乎不起作用,请通过在 Visual Studio Code 中打开终端,然后运行命令
npm run stop来卸载加载项。 关闭服务器窗口不会可靠地停止服务器,关闭 Office 应用程序也不会可靠地导致 Office 取消获取加载项。
旁加载的其他方法
有关旁加载 Excel、PowerPoint 或 Word 加载项的替代方法(包括通过 Teams 中的应用商店),请参阅使用 Microsoft 365 统一清单的旁加载 Office 加载项。
Outlook 中的旁加载
注意
如果你的开发计算机是 Windows,请确保你的 Outlook 客户端是经典 Outlook for Windows,而不是 新的 Outlook on Windows。 当前存在一个 bug,导致使用“代理工具包”创建的加载项无法在新的 Outlook for Windows 或 Outlook 网页版中正确旁加载。
确保 Microsoft 365 开发人员租户中的帐户也是桌面 Outlook 中的电子邮件帐户。 如果没有,请按照向 Outlook 添加电子邮件帐户中的指南进行操作。
关闭 Outlook 桌面。
在 Visual Studio Code 中,打开代理工具包。
在 “帐户” 部分中,验证是否已登录到 Microsoft 365。
选择“在Visual Studio Code 中查看 | 运行”。 在“运行和调试”下拉菜单中,选择选项 Outlook 桌面 (Edge Chromium) ,然后按 F5。 项目生成,并打开“节点开发服务器”窗口。 此过程可能需要几分钟,然后 Outlook 桌面将打开。
注意
如果这是你第一次在计算机 (上旁加载 Office 加载项,或者是一个多月) 来的第一次,系统可能会提示你删除旧证书和/或安装新证书。 同意这两个提示。
打开 Microsoft 365 帐户标识的收件箱,然后打开任何邮件。 如果已在其自己的窗口) 中打开邮件,则带有两个按钮的 Contoso 加载项 选项卡将显示在“ 主页 ”功能区 (或 “邮件 ”功能区。
单击“ 显示任务窗格 ”按钮,将打开任务窗格。 单击“ 执行操作” 按钮,消息顶部附近会显示一个小通知。
注意
无论选择哪个按钮,都会出现 WebView 加载时停止 提示。 选择“确定”。
若要停止调试并卸载加载项,请选择“在 Visual Studio Code 中运行 | 停止调试”。
注意
如果上述步骤似乎不起作用,请通过在 Visual Studio Code 中打开终端,然后运行命令
npm run stop来卸载加载项。 关闭服务器窗口不会可靠地停止服务器,关闭 Office 应用程序也不会可靠地导致 Office 取消获取加载项。
发展项目
现在,可以更改和开发项目。 在 Office 加载项文档中的指南根据所使用的清单类型进行分支的位置,请务必遵循统一清单的指南。