Word JavaScript 预览 API
新Word JavaScript API 首先在“预览版”中引入，然后在进行足够的测试并获取用户反馈后成为特定编号要求集的一部分。
重要
请注意，以下Word预览 API 可能在以下平台上可用。
- Windows 版 Word
- Mac 版 Word
iPad 目前不支持Word预览 API。 但是，Web 上的Word中也可能提供了多个 API。 有关仅在 web 上的 Word 中可用的 API，请参阅仅限 Web 的 API 列表。
注意
预览 API 可能会发生变更，不适合在生产环境中使用。 我们建议你仅在测试和开发环境中试用它们。 不要在生产环境或业务关键型文档中使用预览 API。
若要使用预览 API：
- 必须从 Office.js 内容分发网络 (CDN) 使用 Office JavaScript API 库的预览版。 用于 TypeScript 编译和 IntelliSense 的类型定义文件位于 CDN 和 DefinitelyTyped 中。 可以使用 (安装这些类型
npm install --save-dev @types/office-js-preview，如果以前) 安装过，请确保删除这些类型@types/office-js。 - 可能需要加入 Microsoft 365 预览体验计划 才能访问更新的 Office 版本。
API 列表
下表列出了当前处于预览状态Word JavaScript API，但仅在 web 上的 Word 中可用的 API 除外。 若要查看所有Word JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅所有Word JavaScript API。
| 类 | 域 | 说明 |
|---|---|---|
| ContentControl | resetState () | 重置内容控件的状态。 |
| setState (contentControlState： Word。ContentControlState) | 设置内容控件的状态。 | |
| "文档" | compareFromBase64 (base64File： string， documentCompareOptions？： Word。DocumentCompareOptions) | 显示修订标记，以表明指定的文档与另一个文档的区别。 |
| Font | hidden | 指定一个值，该值指示字体是否标记为隐藏。 |
| 样式 | description | 获取指定样式的说明。 |
仅限 Web 的 API 列表
下表列出了目前仅在 web Word 中处于预览状态的 javaScript API Word。 若要查看所有Word JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅所有Word JavaScript API。
| 类 | 域 | 说明 |
|---|---|---|
| 正文 | onCommentAdded | 在添加新注释时发生。 |
| onCommentChanged | 更改批注或其回复时发生。 | |
| onCommentDeleted | 删除批注时发生。 | |
| onCommentDeselected | 在取消选择批注时发生。 | |
| onCommentSelected | 在选择批注时发生。 | |
| CommentDetail | id | 表示此注释的 ID。 |
| replyIds | 表示对此批注的答复的 ID。 | |
| CommentEventArgs | changeType | 表示如何触发注释更改事件。 |
| commentDetails | 获取 CommentDetail 数组，其中包含所涉及注释的 ID 和回复 ID。 | |
| 源 | 事件的源。 | |
| type | 事件类型。 | |
| ContentControl | onCommentAdded | 在添加新注释时发生。 |
| onCommentChanged | 更改批注或其回复时发生。 | |
| onCommentDeselected | 在取消选择批注时发生。 | |
| onCommentSelected | 在选择批注时发生。 | |
| Paragraph | onCommentAdded | 在添加新注释时发生。 |
| onCommentChanged | 更改批注或其回复时发生。 | |
| onCommentDeleted | 删除批注时发生。 | |
| onCommentDeselected | 在取消选择批注时发生。 | |
| onCommentSelected | 在选择批注时发生。 | |
| 区域 | onCommentAdded | 在添加新注释时发生。 |
| onCommentChanged | 更改批注或其回复时发生。 | |
| onCommentDeselected | 在取消选择批注时发生。 | |
| onCommentSelected | 在选择批注时发生。 |