通过

常见 JavaScript API 对象模型

  • 项目

重要

本文适用于 常见 API，即 Office 2013 中引入的 Office JavaScript API 模型。 这些 API 包括在多种类型的 Office 应用程序中都很常见的 UI、对话框和客户端设置等功能。 Outlook 加载项仅使用通用 API，尤其是通过邮箱对象公开的 API 子集。

对于特定于应用程序的 API 不支持的场景，应仅使用通用 API。 若要了解何时使用通用 API（而非特定于应用程序的 API），请参阅了解 Office JavaScript API。

Office JavaScript API 授予对 Office 客户端应用程序基础功能的访问权限。 大多数此类访问权限可以访问一些重要的对象。 Context 对象提供在初始化之后对运行时环境的访问权限。 Document 对象使用户能够控制 Excel、PowerPoint 或 Word 文档。 Mailbox 对象授予 Outlook 加载项对邮件、约会和用户配置文件的访问权限。 了解这些高级对象之间的关系是 Office 外接程序的基础。

Context 对象

适用于：所有加载项类型

如果加载项已初始化，则它具有许多可在运行时环境中交互的不同对象。 加载项的运行时上下文通过 Context 对象反应在 API 中。 Context 是主要对象，它提供对大部分 API 最重要对象的访问权限，例如 Document 和 Mailbox 对象，二者反过来又提供对文档和邮箱内容的访问权限。

例如，在任务窗格或内容外接程序中，可以使用 Context 对象的 document 属性访问 Document 对象的属性和方法，以便与 Word 文档、Excel 工作表或 Project 计划的内容交互。 类似地，在 Outlook 外接程序中，可以使用 Context 对象的 mailbox 属性访问 Mailbox 对象的属性和方法，以便与邮件、会议请求或约会内容交互。

Context 对象还提供对 contentLanguage 和 displayLanguage 属性的访问权限，这些属性使你可以确定文档或项目或 Office 应用程序中使用的区域设置 (语言) 。 roamingSettings 属性使你能够访问 RoamingSettings 对象的成员，该对象用于存储各用户邮箱的加载项特定的设置。 最后，Context 对象提供一个允许你的加载项启动弹出对话框的 ui 属性。

Document 对象

适用于： 内容和任务窗格加载项类型

为了与 Excel、PowerPoint 和 Word 中的文档数据交互，API 提供 Document 对象。 可以使用 Document 对象成员通过以下方式访问数据。

  • 读取和写入文本形式、连续单元格（矩阵）或表格中的活动选区。

  • 表格数据（矩阵或表格）。

  • 绑定 (对象) 的 Bindings “add”方法创建。

  • 自定义 XML 部件（仅适用于 Word）。

  • 文档上按加载项保留的设置或加载项状态。

还可以使用 Document 对象与 Project 文档中的数据进行交互。 特定于 Project 的 API 功能记录在成员 ProjectDocument 抽象类中。 有关为 Project 创建任务窗格加载项的详细信息，请参阅适用于 Project 的任务窗格加载项。

所有这些形式的数据访问都从抽象 Document 对象的实例开始。

使用 对象的 文档属性初始化任务窗格或内容加载项时，可以访问 对象的Context实例Document。 对象Document定义跨 Word 和 Excel 文档共享的常见数据访问方法，并为Word文档提供对 对象的访问CustomXmlParts。

对象 Document 支持开发人员通过四种方式访问文档内容。

  • 基于选区的访问

  • 基于绑定的访问

  • 基于自定义 XML 部件的访问（仅适用于 Word）

  • 基于整个文档的访问（仅适用于 PowerPoint 和 Word）

为了帮助您理解基于选区和绑定的数据访问方法的工作方式，我们将首先解释数据访问 API 如何跨不同的 Office 应用程序提供一致的数据访问。

跨 Office 应用程序的一致数据访问

适用于：内容和任务窗格加载项类型

为了创建跨不同 Office 文档无缝工作的扩展，Office JavaScript API 通过常见数据类型和将不同文档内容强制转换为三种常见数据类型的功能，抽象化了每个 Office 应用程序的特殊性。

通用数据类型

在基于选区和基于绑定的数据访问中，文档内容通过跨所有受支持的 Office 应用程序通用的数据类型来公开。 支持三种main数据类型。

数据类型 说明 主机应用程序支持
文本 提供选定范围或绑定中数据的字符串表示形式。 在 Excel、Project 和 PowerPoint 中，仅支持纯文本。 Word支持三种文本格式：纯文本、HTML 和 Office Open XML (OOXML) 。 如果选中的是 Excel 单元格中的文本，基于选定范围的方法会对单元格的全部内容执行读取和写入操作，即使仅选中了单元格中的部分文本，也不例外。 如果选中的是 Word 和 PowerPoint 中的文本，基于选定范围的方法只会对选中的一系列字符执行读取和写入操作。 Project 和 PowerPoint 仅支持基于选择的数据访问。
矩阵 将选定范围或绑定中的数据作为二维 Array 提供，这在 JavaScript 中实现为一组数组。 例如，两行两列 string 值为 [['a', 'b'], ['c', 'd']]，而三行一列则为 [['a'], ['b'], ['c']]。 仅在 Excel 和 Word 中支持矩阵数据访问。
表格 将选区或绑定中的数据作为 TableData 对象提供。 对象 TableData 通过 headers 和 rows 属性公开数据。 仅 Excel 和 Word 中支持表数据访问。

数据类型强制转换

和 Binding 对象上的Document数据访问方法支持使用这些方法的 coercionType 参数和相应的 CoercionType 枚举值指定所需的数据类型。 不管绑定的实际形状如何，不同的 Office 应用程序都通过尝试将数据强制转换为请求的数据类型来支持通用的数据类型。 例如，如果选中了某个 Word 表格或段落，开发人员可以指定将其读取为纯文本、HTML、Office Open XML 或表格，而 API 实现处理必要的转换和数据转换。

提示

何时应使用矩阵与表格 coercionType 数据访问？ 如果需要表格数据在添加行和列时动态增长，并且必须使用表标题，则应通过将 或 对象数据访问方法的 DocumentBindingcoercionType 参数指定为 "table" 或 Office.CoercionType.Table) 来使用表数据类型 (。 表格数据和矩阵数据中都支持在数据结构内添加行和列，但仅支持对表格数据追加行和列。 如果不打算添加行和列，并且数据不需要标头功能，则应通过将数据访问方法的 coercionType 参数指定为 "matrix" 或 Office.CoercionType.Matrix) 来使用矩阵数据类型 (，从而提供与数据交互的更简单模型。

如果无法将数据强制转换为指定的类型，那么回调中的 AsyncResult.status 属性返回 "failed"，并且你可以使用 AsyncResult.error 属性访问 Error 对象，其中包括方法调用失败原因的信息。

使用 Document 对象处理所选内容

对象 Document 公开方法，使你可以以“获取和设置”方式读取和写入用户的当前选择。 为此， Document 对象提供 getSelectedDataAsync 和 setSelectedDataAsync 方法。

有关演示如何使用选区执行任务的代码示例，请参阅在文档或电子表格的活动选区中读取和写入数据。

使用 Bindings 和 Binding 对象处理绑定

基于绑定的数据访问使内容和任务窗格加载项能够通过与绑定相关联的标识符一致地访问文档或电子表格的特定区域。 加载项首先需要通过调用将文档的某一部分与唯一标识符相关联的以下某个方法来建立绑定：addFromPromptAsync、addFromSelectionAsync 或 addFromNamedItemAsync。 建立绑定后，加载项可以使用提供的标识符访问文档或电子表格的关联区域中包含的数据。 创建绑定可为加载项提供以下值。

  • 允许访问跨支持的 Office 应用程序的通用数据结构，例如：表、区域或文本（一系列连续字符）。

  • 允许读/写操作，而不需要用户做出选择。

  • 在加载项和文档中的数据之间建立关系。 绑定会保留在文档中，以后可以进行访问。

建立绑定还允许您订阅仅限文档或电子表格的特定区域的数据和选择更改事件。 这意味着，加载项只会收到绑定区域内发生的更改的通知，而不是收到整个文档或电子表格内的常规更改的通知。

Bindings 对象公开 getAllAsync 方法，通过该方法可以访问在文档或电子表格中建立的所有绑定的集合。 可以使用 Bindings.getBindingByIdAsync 方法或 Office.select 函数通过其 ID 访问单个绑定。 可以使用对象的以下方法 Bindings 之一建立新绑定以及删除现有绑定： addFromSelectionAsync、 addFromPromptAsync、 addFromNamedItemAsync 或 releaseByIdAsync。

使用 或 addFromNamedItemAsync 方法创建绑定时，可以使用 bindingType 参数指定三种不同类型的绑定addFromSelectionAsyncaddFromPromptAsync。

绑定类型 说明 主机应用程序支持
文本绑定 绑定到可以文本形式表示的文档区域。 在 Word 中，大多数连续选区都是有效的，而在 Excel 中，只有单个单元格选区才能作为文本绑定的目标。 在 Excel 中，只支持纯文本。 在 Word 中，支持以下三种格式：纯文本、HTML 和 Open XML for Office。
矩阵绑定 绑定到包含表格数据（不带标题）的文档的固定区域。 矩阵绑定中的数据以二维 Array（在 JavaScript 中实现为一组数组）的形式进行写入或读取。 例如，两行两列 string 值可以写入或读取为 [['a', 'b'], ['c', 'd']]，而三行单列则可以写入或读取为 [['a'], ['b'], ['c']]。 在 Excel 中，任何连续选择的单元格都可用于建立矩阵绑定。 在 Word 中，只有表格支持矩阵绑定。
表格绑定 绑定到包含带标题的表格的文档区域。 表格绑定中的数据作为 TableData 对象写入或读取。 对象 TableData 通过 标头 和 行 属性公开数据。 任何 Excel 或 Word 表格均可作为表格绑定的基础。 建立表格绑定后，用户添加到表格中的每个新行或新列都自动包含在绑定中。

使用对象的三个“add”方法 Bindings 之一创建绑定后，可以使用相应对象的方法处理绑定的数据和属性： MatrixBinding、 TableBinding 或 TextBinding。 这三个对象都继承对象的 getDataAsync 和 setDataAsync 方法，这些方法 Binding 使你能够与绑定数据进行交互。

有关演示如何使用绑定执行任务的代码示例，请参阅绑定到文档或电子表格中的区域。

使用 CustomXmlParts 和 CustomXmlPart 对象处理自定义 XML 部件

适用于：Word 的任务窗格加载项

API 的 CustomXmlParts 和 CustomXmlPart 对象提供访问 Word 文档中自定义 XML 部件的权限，从而启用文档内容的 XML 驱动操作。 有关使用 CustomXmlParts 和 CustomXmlPart 对象的演示，请参阅 Word-add-in-Work-with-custom-XML-parts 代码示例。

使用 getFileAsync 方法处理整个文档

适用于：Word 和 PowerPoint 任务窗格加载项

Document.getFileAsync 方法以及 File 和 Slice 对象的成员可用于一次性获取整个 Word 和 PowerPoint 文档文件，所有切片（区块）的总大小上限为 4MB。 有关详细信息，请参阅通过 PowerPoint 或 Word 加载项获取整个文档。

Mailbox 对象

适用于： Outlook 外接程序

Outlook 外接程序主要使用通过 Mailbox 对象公开的 API 的子集。 若要访问专门用于 Outlook 加载项的对象和成员（如 Item 对象），请使用 Context 对象的 mailbox 属性来访问 Mailbox 对象，如以下代码行所示。

// Access the Item object.
const item = Office.context.mailbox.item;

重要

在邮件上调用 Office.context.mailbox.item 时，请注意，必须打开 Outlook 客户端中的阅读窗格。 有关如何配置阅读窗格的指南，请参阅 使用和配置阅读窗格预览邮件。

此外，Outlook 加载项可以使用以下对象。

  • Office 对象：用于初始化。

  • Context 对象：用于访问内容和显示语言属性。

有关在 Outlook 外接程序中使用 JavaScript 的信息，请参阅 Outlook 外接程序。若要浏览 Outlook JavaScript API，请参阅 Outlook API 参考 页。