通过

生成首个 Project 任务窗格加载项

  • 项目

本文将逐步介绍如何生成 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

命令行界面中 Yeoman 生成器的提示和回答。

完成此向导后，生成器会创建项目，并安装支持的 Node 组件。

浏览项目

使用 Yeoman 生成器创建的加载项项目包含适合于基础任务窗格加载项的示例代码。

  • 项目根目录中的 ./manifest.xml 文件定义加载项的设置和功能。
  • ./src/taskpane/taskpane.html 文件包含组成任务窗格的 HTML。
  • ./src/taskpane/taskpane.css 文件包含应用于任务窗格中的内容的 CSS。
  • ./src/taskpane/taskpane.js 文件包含用于加快任务窗格与 Office 客户端应用程序之间的交互的 Office JavaScript API 代码。 在本快速入门中，代码设置了项目所选任务的 Name 字段和 Notes 字段。

试用

  1. 导航到项目的根文件夹。

    cd "My Office Add-in"

  2. 启动本地 Web 服务器。

    注意

    • 即使在开发过程中，Office 外接程序也应使用 HTTPS，而不是 HTTP。 如果在运行以下命令之一后系统提示安装证书，请接受安装 Yeoman 生成器提供的证书的提示。 你可能还必须以管理员身份运行命令提示符或终端才能进行更改。

    • 如果这是你第一次在计算机上开发 Office 加载项，则命令行中可能会提示你授予Microsoft Edge WebView 环回豁免 (“允许 Microsoft Edge WebView 的 localhost 环回？”) 。 出现提示时，输入 Y 以允许豁免。 请注意，需要管理员权限才能允许豁免。 一旦允许，在将来 (旁加载 Office 加载项时，系统就不会提示你获得豁免，除非从计算机) 中删除该豁免。 若要了解详细信息，请参阅加载 Office 外接程序或使用 Fiddler 时，“我们无法从 localhost 打开此外接程序”。

      命令行中允许Microsoft Edge WebView 环回豁免的提示。

    在项目的根目录中运行以下命令。 运行此命令时，本地 Web 服务器将启动。

    npm run dev-server

  3. 在 Project 中，创建一个简单的项目计划。

  4. 按照在 Windows 上旁加载 Office 加载项中的说明，在 Project 中加载你的加载项。

  5. 在项目中选择单个任务。

  6. 在任务窗格的底部，选择“运行”链接以重命名所选任务并向所选任务添加备注。

    加载了任务窗格加载项的 Project 应用程序。

  7. 如果要停止本地 Web 服务器并卸载加载项，请按照以下说明操作：

    • 若要停止服务器，请运行以下命令。

      npm stop

    • 若要卸载旁加载的加载项，请参阅 删除旁加载加载项。

后续步骤

恭喜！已成功创建 Project 任务窗格加载项！ 接下来，请详细了解 Project 加载项功能，并探索常见方案。

Project 加载项

疑难解答

  • Yo Office 执行的自动 npm install 步骤可能会失败。 如果在尝试运行 npm start时看到错误，请在命令提示符中导航到新创建的项目文件夹并手动运行 npm install。 有关 Yo Office 的详细信息，请参阅 使用 Yeoman 生成器创建 Office 外接程序项目。

另请参阅