本文将逐步介绍如何生成 Project 任务窗格加载项。
先决条件
Node.js (最新的活动 LTS 版本) 。 访问 Node.js 网站 ,下载并安装适合你的操作系统的正确版本。
最新版本的 Yeoman 和适用于 Office 加载项的 Yeoman 生成器。若要全局安装这些工具,请从命令提示符处运行以下命令。
npm install -g yo generator-office注意
即便先前已安装了 Yeoman 生成器,我们还是建议你通过 npm 将包更新为最新版本。
已连接到 Microsoft 365 订阅的 Office (包括 Office 网页版)。
注意
如果还没有 Office,可能有资格通过 Microsoft 365 开发人员计划获得 Microsoft 365 E5 开发人员订阅;有关详细信息,请参阅常见问题解答。 或者,你可以 注册 1 个月的免费试用 版或 购买 Microsoft 365 计划。
- Windows 版 Project 2016 或更高版本
创建加载项
运行以下命令,使用 Yeoman 生成器创建加载项项目。 包含该项目的文件夹将添加到当前目录。
yo office
注意
运行该yo office命令时,可能会收到有关 Yeoman 和 Office 加载项 CLI 工具的数据收集策略的提示。 根据你的需要,使用提供的信息来响应提示。
出现提示时,请提供以下信息以创建加载项项目。
-
选择项目类型:
Office Add-in Task Pane project -
选择脚本类型:
JavaScript -
要给加载项命名为什么?
My Office Add-in -
你希望支持哪种 Office 客户端应用程序?
Project
完成此向导后,生成器会创建项目,并安装支持的 Node 组件。
浏览项目
使用 Yeoman 生成器创建的加载项项目,包含适合于基础任务窗格加载项的示例代码。
- 项目根目录中的 ./manifest.xml 文件定义加载项的设置和功能。
- ./src/taskpane/taskpane.html 文件包含组成任务窗格的 HTML。
- ./src/taskpane/taskpane.css 文件包含应用于任务窗格中的内容的 CSS。
-
./src/taskpane/taskpane.js 文件包含用于加快任务窗格与 Office 客户端应用程序之间的交互的 Office JavaScript API 代码。 在本快速入门中,代码设置了项目所选任务的
Name字段和Notes字段。
试用
导航到项目的根文件夹。
cd "My Office Add-in"完成以下步骤,以启动本地 Web 服务器并旁加载你的加载项。
注意
Office 加载项应使用 HTTPS,而不是 HTTP,即使在开发过程中也是如此。 如果在运行以下命令之一后收到安装证书的提示,请接受安装 Yeoman 生成器提供的证书的提示。 你可能还必须以管理员身份运行命令提示符或终端才能进行更改。
如果这是你首次在计算机上开发 Office 加载项,系统可能会在命令行中提示你授予 Microsoft Edge WebView 环回豁免 (“允许 Microsoft Edge WebView 的 localhost 环回?”) 。 出现提示时,输入以
Y允许豁免。 请注意,需要管理员权限才能允许豁免。 一旦允许,则将来 (旁加载 Office 加载项时不应提示你获得豁免,除非你从计算机) 中删除了豁免。 若要了解详细信息,请在 加载 Office 加载项或使用 Fiddler 时查看“我们无法从本地主机打开此加载项”。
首次使用 Yeoman 生成器开发 Office 加载项时,默认浏览器会打开一个窗口,提示你登录到 Microsoft 365 帐户。 如果登录窗口未出现,并且遇到旁加载或登录超时错误,请运行
atk auth login m365。
若要在 Project 中测试加载项,请在项目的根目录中运行以下命令。 这将启动本地 Web 服务器并旁加载加载加载项。
npm start
如果加载项不会自动旁加载,请按照 Windows 上的旁加载 Office 加载项 中的说明在 Project 中手动旁加载加载加载项。
在 Project 中,创建一个简单的项目计划。
在项目中选择单个任务。
在任务窗格的底部,选择“运行”链接以重命名所选任务并向所选任务添加备注。
当您想要停止本地 Web 服务器并卸载加载项时,请按照适用的说明操作:
要停止服务器,请运行以下命令。 如果使用
npm start,以下命令也会卸载加载项。npm stop如果手动旁加载了加载项,请参阅 删除旁加载的外接程序。
疑难解答
- 按照 “设置开发环境”中的说明,确保你的环境已准备好进行 Office 开发。
Yo Office 执行的自动
npm install步骤可能会失败。 如果在尝试运行npm start时看到错误,请导航到命令提示符下新创建的项目文件夹,然后手动运行npm install。 有关 Yo Office 的详细信息,请参阅 使用 Yeoman 生成器创建 Office 加载项项目。在为 Yeoman 生成器或项目运行
npm install时,可能会看到生成的警告。 在大多数情况下,可以放心地忽略这些警告。 安全或审核警告需要单独评估;在部署到生产环境之前,解决运行时依赖项或无法确定其来源的依赖项中的漏洞。 有时,依赖项将被弃用,并且项目依赖的其他包不支持它们的替换。 若要查看可用的依赖项更新,请使用该npm-check-updates工具。- 在根项目目录中的命令提示符下,运行
npm i -g npm-check-updates。 这会全局安装该工具。 - 运行
ncu以报告可用更新,而无需修改 package.json。 - 查看建议的版本的兼容性,并在 package.json 中仅更新适当的依赖项范围,然后运行
npm install。 请注意,ncu -u重写依赖项范围,并且可能包括中断性主要版本升级。
有关运行
npm install时警告的更多信息,请参阅 Node.js 和 npm 世界中的警告和依赖项。- 在根项目目录中的命令提示符下,运行
如果在功能区 (上看不到加载项按钮,例如“显示任务窗格) ”,请从“主页”功能区选项卡中选择“加载项”按钮,然后选择测试加载项。
后续步骤
恭喜!已成功创建 Project 任务窗格加载项! 接下来,请详细了解 Project 加载项功能,并探索常见方案。