Word JavaScript API 仅限桌面的要求集 1.1

  • 项目

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

当所有平台都支持要求集中的 WordApiDesktop API 时，它们将添加到下一个发布的要求集 (WordApi 1.[NEXT]) 。 新要求集公开后，这些 API 将继续在此 WordApiDesktop 要求集中标记。

重要

WordApiDesktop 1.1 是仅限桌面的要求集。 它是 WordApi 1.8 和 WordApiHiddenDocument 1.5 要求集的超集。

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

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
   // Any API exclusive to the WordApiDesktop requirement set.
}

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

重要

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

API 列表

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

类 域 说明
Border color 指定边框的颜色。
location 获取边框的位置。
type 指定边框的边框类型。
visible 指定边框是否可见。
width 指定边框的宽度。
BorderCollection getByLocation (borderLocation：Word.BorderLocation.top |Word。BorderLocation.left |Word。BorderLocation.bottom |Word。BorderLocation.right |Word。BorderLocation.insideHorizontal |Word。BorderLocation.insideVertical |“Top” |“Left” |“Bottom” |“Right” |“InsideHorizontal” |“InsideVertical”) 获取具有指定位置的边框。
getFirst() 获取此集合中的第一个边框。
getFirstOrNullObject () 获取此集合中的第一个边框。
getItem(index: number) 按集合中的索引获取 Border 对象。
insideBorderColor 指定内部边框的 24 位颜色。
insideBorderType 指定内部边框的边框类型。
insideBorderWidth 指定内部边框的宽度。
items 获取此集合中已加载的子项。
outsideBorderColor 指定外部边框的 24 位颜色。
outsideBorderType 指定外边框的边框类型。
outsideBorderWidth 指定外边框的宽度。
"文档" 比较 (filePath： string， documentCompareOptions？： Word。DocumentCompareOptions) 显示修订标记，以表明指定的文档与另一个文档的区别。
DocumentCompareOptions addToRecentFiles True 将文档添加到 文件菜单上最近使用的文件列表。
authorName 与比较生成的区别相关联的审阅者姓名。
compareTarget 比较的目标文档。
detectFormatChanges 真 (默认值) 进行比较以包含检测到的格式更改。
ignoreAllComparisonWarnings 真正 比较文档，而不必通知用户有问题存在。
removeDateAndTime 为 日期和时间戳信息从修订中移除返回的 文档 对象中。
removePersonalInformation 如果为 True，则从返回的 Document 对象中的注释、修订和属性对话框中删除所有用户信息。
字段 showCodes 指定是否显示指定字段的域代码。
InlinePicture imageFormat 获取内联图像的格式。
List getLevelFont (级别：数字) 获取列表中指定级别的项目符号、数字或图片的字体。
getLevelPicture (level： number) 获取列表中指定级别的图片的 Base64 编码字符串表示形式。
resetLevelFont (level： number， resetFontName？： boolean) 重置列表中指定级别的项目符号、数字或图片的字体。
setLevelPicture (级别： number， base64EncodedImage？： string) 在列表中的指定级别设置图片。
ListLevel 对准 指定列表级别的水平对齐方式。
font 获取一个 Font 对象，该对象表示指定对象的字符格式设置。
linkedStyle 指定链接到指定列表级别对象的样式的名称。
numberFormat 指定指定列表级别的数字格式。
numberPosition 指定指定列表级别对象的编号或项目符号) 位置 (以磅为单位。
numberStyle 指定列表级别对象的编号样式。
resetOnHigher 指定在指定的列表级别重新启动编号为 1 之前必须显示的列表级别。
startAt 指定指定列表级别对象的起始编号。
tabPosition 指定指定列表级别对象的选项卡位置。
textPosition 指定指定列表级别对象的第二行换行文本 () 的位置（以磅为单位）。
trailingCharacter 指定在指定列表级别的数字之后插入的字符。
ListLevelCollection getFirst() 获取此集合中的第一个列表级别。
getFirstOrNullObject () 获取此集合中的第一个列表级别。
items 获取此集合中已加载的子项。
ListTemplate listLevels 获取一个 ListLevels 集合，该集合代表指定 ListTemplate 的所有级别。
outlineNumbered 指定指定的 ListTemplate 对象是否为大纲编号。
Shading foregroundPatternColor 指定对象的前景的颜色。
质地 指定对象的底纹纹理。
样式 Borders 指定一个 BorderCollection 对象，该对象代表指定样式的所有边框。
listTemplate 获取一个 ListTemplate 对象，该对象代表指定 Style 对象的列表格式。
TableRow insertContentControl() 在行中插入内容控件。
TableStyle 对准 指定表与页边距的对齐方式。
allowBreakAcrossPage 指定用指定样式设置格式的表中的行是否跨页分隔。

另请参阅