通过

Word 加载项概述

  • 项目

要创建解决方案来扩展 Word 功能？ 例如，涉及自动文档程序集的解决方案？ 或从其他数据源绑定到并访问 Word 文档中数据的解决方案？ 可以使用 Office 外接程序平台（包括 Word JavaScript API 和 Office JavaScript API）来扩展在 Web、Windows 桌面或 Mac 上运行Word客户端。

Word 外接程序是 Office 外接程序平台中的众多开发选项之一。 外接程序命令可用于扩展 Word 用户界面并启动运行 JavaScript 并与 Word 文档中内容交互的任务窗格。 在浏览器中可以运行的任何代码均可在 Word 外接程序中运行。 与 Word 文档中的内容进行交互的外接程序可创建作用于 Word 对象的请求并同步对象状态。

注意

如果你计划将加载项发布到 AppSource，并使其在 Office 体验中可用，请确保你遵守商业市场认证政策。 例如，加载项必须适用于支持你定义的方法的所有平台，才能通过验证（有关详细信息，请参阅第 1120.3 部分以及 Office 加载项应用程序和可用性页）。

下图中的示例展示了在任务窗格中运行的 Word 加载项。

在 Word 的任务窗格中运行的加载项。

Word加载项可以执行以下操作：

  1. 将请求发送到Word文档。
  2. 使用 JavaScript 访问段落对象并更新、删除或移动段落。

例如，以下代码演示如何将新句子追加到第一个所选段落。

await Word.run(async (context) => {
  const paragraphs = context.document.getSelection().paragraphs;
  paragraphs.load();
  await context.sync();
  paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                   Word.InsertLocation.end);
  await context.sync();
});

可以使用任何 Web 服务器技术承载 Word 外接程序，如 ASP.NET、NodeJS 或 Python。 使用你最喜欢的客户端框架（Ember、Backbone、Angular、React），或坚持使用普通 JavaScript 来开发解决方案。 还可以使用 Azure 等服务 对应用程序进行身份验证 和托管。

通过 Word JavaScript API 可使应用程序访问 Word 文档中的对象和元数据。 可以使用这些 API 创建面向以下客户端的外接程序。

  • Word 网页版
  • Windows 上的Word 2016或更高版本
  • Mac 版 Word
  • iPad 版 Word

编写加载项一次，它将跨多个平台在所有受支持的 Word 版本中运行。 有关详细信息，请参阅 Office 外接程序的 Office 客户端应用程序和平台可用性。

适用于 Word 的 JavaScript API

有两组 JavaScript API 可用于与 Word 文档中的对象和元数据进行交互。 第一组是在 Office 2013 中引入的通用 API。 通用 API 中的许多对象可以在由两个或多个 Office 客户端托管的加载项中使用。 此 API 广泛使用回调。

第二组是 Word JavaScript API。 这是与 Word 2016 一起引入的特定于应用程序的 API 模型。 它是强类型对象模型，可用于在 Windows 和 Mac 上创建面向Word 2016及更高版本的Word加载项。 此对象模型使用 promises，并提供对特定于Word对象的访问，例如正文、内容控件、内联图片和段落。 Word JavaScript API 包括 TypeScript 定义和 vsdoc 文件，这样，您可以在 IDE 中获得代码提示。

目前，所有 Word 客户端均支持共享的 Office JavaScript API，大多数客户端支持 Word JavaScript API。 有关受支持的客户端的详细信息，请参阅 Office 客户端应用程序和 Office 加载项的平台可用性。

我们建议从 Word JavaScript API 开始，因为对象模型更易于使用。 如果需要访问 Word 文档中的对象，请使用 Word JavaScript API。

需要执行以下任一操作时，请使用共享的 Office JavaScript API：

  • 对应用程序执行初始化操作。
  • 检查支持的要求集。
  • 访问文档的元数据、设置和环境信息。
  • 绑定到文档中的部分并捕获事件。
  • 打开一个对话框。

后续步骤

准备创建第一个 Word 外接程序？ 请参阅构建您的第一个 Word 外接程序。 使用 外接程序清单 描述外接程序的托管位置、显示方式以及定义权限和其他信息。

若要详细了解如何设计一个世界级的Word加载项，以便为用户创建引人注目的体验，请参阅设计指南和最佳做法。

开发加载项后，可以将它发布到网络共享、应用目录或 AppSource。

另请参阅