Word JavaScript API 隐藏文档要求集 1.4

要求 WordApiHiddenDocument 1.4 集是一个特殊要求集,包括仅适用于 Windows 和 Mac 上的 Word 的功能。 此要求集中的 API 被视为 Windows 和 Mac 上的 Word 应用程序的生产 API。 它们遵循 Microsoft 365 开发人员支持策略WordApiHiddenDocument API 被视为其他平台 (Web、iPad) 的“预览”API,并且可能不受其中任何平台的支持。

当所有平台都支持要求集中的 WordApiHiddenDocument API 时,它们将添加到后续发布的要求集中, (WordApi 1.[FUTURE]) ,并且不再标记为 WordApiHiddenDocument。 将此视为从预览版到发布的 API 的类似升级过程。

重要

WordApiHiddenDocument 1.4 是 WordApi 1.4 和 WordApiHiddenDocument 1.3 要求集的超集,是仅限桌面的要求集。

由于 WordApiHiddenDocument API 仅受 Windows 和 Mac 上的 Word 支持,因此外接程序应在调用这些 API 之前检查要求集是否受支持。 这可避免在不支持的平台上尝试使用仅限桌面的 API。

if (Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.4")) {
   // Any API exclusive to this desktop-only requirement set.
}

API 进入跨平台要求集后,应删除或编辑 isSetSupported 检查。 这将在其他平台上启用加载项的功能。 进行此更改时,请务必在这些平台上测试该功能。

重要

清单不能指定 WordApiHiddenDocument 1.4 为激活要求。 它不是 在 Set 元素中使用的有效值。

API 列表

下表列出了当前包含在要求集中的 WordApiHiddenDocument Word JavaScript API。 有关所有 Word JavaScript API 的完整列表, (包括 WordApiHiddenDocument API 和以前发布的 API) ,请参阅 所有 Word JavaScript API

说明
DocumentCreated customXmlParts 获取文档中的自定义 XML 部件。
deleteBookmark (name: string) 从文档中删除书签(如果存在)。
getBookmarkRange (名称:string) 获取书签的范围。
getBookmarkRangeOrNullObject (name: string) 获取书签的范围。
设置 获取文档中加载项的设置。

另请参阅