Word JavaScript API 隐藏文档要求集 1.5

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

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

重要

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

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

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

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

重要

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

API 列表

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

说明
DocumentCreated addStyle (name: string, type: Word。StyleType) 按名称和类型向文档中添加样式。
getContentControls (选项?:Word。ContentControlOptions) 获取文档中当前支持的内容控件。
getStyles () 获取一个 StyleCollection 对象,该对象代表文档的整个样式集。
insertFileFromBase64 (base64File: string, insertLocation: Word。InsertLocation.replace |Word。InsertLocation.start |Word。InsertLocation.end |“Replace” |“Start” |“End”, insertFileOptions?: Word。InsertFileOptions) 使用其他属性将文档插入到目标文档中的特定位置。
save (saveBehavior?: Word。SaveBehavior,fileName?: string) 保存文档。

另请参阅