通过

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

要求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.2 是仅限桌面的要求集。 它是 WordApi 1.9 和 WordApiDesktop 1.1 的超集。

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

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

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

重要

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

API 列表

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

类 域 说明
正文 shapes 获取正文中形状对象的集合，包括内联形状和浮动形状。
画布 id 获取表示画布标识符的整数。
shape 获取与画布关联的 Shape 对象。
shapes 获取 Shape 对象的集合。
"文档" activeWindow 获取文档的活动窗口。
compareFromBase64 (base64File： string， documentCompareOptions？： Word。DocumentCompareOptions) 显示修订标记，以表明指定的文档与另一个文档的区别。
windows 获取文档的 Word.Window 对象的集合。
Font hidden 指定一个值，该值指示字体是否标记为隐藏。
InsertShapeOptions height 表示要插入的形状的高度。
left 表示要插入的形状的左侧位置。
top 表示要插入的形状的顶部位置。
width 表示要插入的形状的宽度。
Page getNext () 获取窗格中的下一页。
getNextOrNullObject () 获取下一页。
getRange (rangeLocation？： Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |“整个” |“Start” |“End”) 获取整个页面，或者页面的起始点或终点作为范围。
height 获取在“页面设置”对话框中定义的纸张的高度（以磅为单位）。
index 获取页面的索引。
width 获取“页面设置”对话框中定义的纸张的宽度（以磅为单位）。
PageCollection getFirst() 获取此集合中的第一页。
getFirstOrNullObject () 获取此集合中的第一页。
items 获取此集合中已加载的子项。
窗格 getNext () 获取窗口中的下一个窗格。
getNextOrNullObject () 获取下一个窗格。
pages 获取窗格中页面的集合。
pagesEnclosingViewport PageCollection获取窗格的视区中显示的 。
PaneCollection getFirst() 获取此集合中的第一个窗格。
getFirstOrNullObject () 获取此集合中的第一个窗格。
items 获取此集合中已加载的子项。
Paragraph insertCanvas (insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入一个浮动画布，其定位点位于段落开头。
insertGeometricShape (geometricShapeType：Word。GeometricShapeType， insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入几何形状，其定位点位于段落开头。
insertPictureFromBase64 (base64EncodedImage： string， insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入浮动图片，其定位点位于段落开头。
insertTextBox (text？： string， insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入一个浮动文本框，其定位点位于段落开头。
shapes 获取在段落中定位的形状对象的集合，包括内联形状和浮动形状。
区域 insertCanvas (insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入浮动画布，其定位点位于区域开头。
insertGeometricShape (geometricShapeType：Word。GeometricShapeType， insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入一个几何形状，其定位点位于区域开头。
insertPictureFromBase64 (base64EncodedImage： string， insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入浮动图片，其定位点位于区域开头。
insertTextBox (text？： string， insertShapeOptions？： Word。InsertShapeOptions) 在文本前面插入一个浮动文本框，其定位点位于区域开头。
pages 获取区域中页面的集合。
shapes 获取在范围中定位的形状对象的集合，包括内联形状和浮动形状。
Shape allowOverlap 指定给定的形状是否可以与其他形状重叠。
altTextDescription 指定表示与形状关联的可选文本的字符串。
body 表示形状的正文对象。
帆布 获取与形状关联的画布。
delete() 删除形状及其内容。
fill 返回形状的填充格式。
geometricShapeType 形状的几何形状类型。
height 形状的高度（以磅为单位）。
heightRelative 形状高度与垂直相对大小的百分比，请参阅Word。RelativeSize。
id 获取表示形状标识符的整数。
isChild 检查此形状是组形状还是画布形状的子形状。
left 从形状左侧到水平相对位置的距离（以磅为单位），请参阅Word。RelativeHorizontalPosition。
leftRelative 相对左侧位置（从形状左侧到水平相对位置的百分比），请参阅 Word。RelativeHorizontalPosition。
lockAspectRatio 指定是否锁定此形状的纵横比。
moveHorizontally (distance： number) 按磅数水平移动形状。
moveVertically (distance： number) 按磅数垂直移动形状。
名称 形状的名称。
parentCanvas 获取此子形状的顶级父画布形状。
parentGroup 获取此子形状的顶级父组形状。
relativeHorizontalPosition 形状的相对水平位置。
relativeHorizontalSize 形状的相对水平大小。
relativeVerticalPosition 形状的相对垂直位置。
relativeVerticalSize 形状的相对垂直大小。
rotation 指定形状的旋转（以度为单位）。
scaleHeight (scaleFactor： number， scaleType： Word。ShapeScaleType， scaleFrom？： Word。ShapeScaleFrom) 按指定因子缩放形状的高度。
scaleWidth (scaleFactor： number， scaleType： Word。ShapeScaleType， scaleFrom？： Word。ShapeScaleFrom) 按指定因子缩放形状的宽度。
select (selectMultipleShapes？： boolean) 选择形状。
shapeGroup 获取与形状关联的形状组。
textFrame 获取形状的文本框架对象。
textWrap 返回形状的文本换行格式。
top 从形状的上边缘到垂直相对位置的距离（以磅为单位）， (看到Word。RelativeVerticalPosition) 。
topRelative 相对顶部位置（从形状的上边缘到垂直相对位置的百分比），请参阅 Word。RelativeVerticalPosition。
type 获取形状类型。
visible 指定形状是否可见。
width 形状的宽度（以磅为单位）。
widthRelative 形状宽度与水平相对大小的百分比，请参阅Word。RelativeSize。
ShapeCollection getByGeometricTypes (类型：Word。GeometricShapeType[]) 获取具有指定几何类型的形状。
getById(id: number) 按标识符获取形状。
getByIdOrNullObject (id： number) 按标识符获取形状。
getByIds (ids： number[]) 按标识符获取形状。
getByNames (name： string[]) 获取具有指定名称的形状。
getByTypes (类型：Word。ShapeType[]) 获取具有指定类型的形状。
getFirst() 获取此集合中的第一个形状。
getFirstOrNullObject () 获取此集合中的第一个形状。
组 () 在此集合中对浮动形状进行分组，将跳过内联形状。
items 获取此集合中已加载的子项。
ShapeFill backgroundColor 指定形状填充背景色。
clear() 清除此形状的填充格式并将其设置为 Word.ShapeFillType.NoFill;
foregroundColor 指定形状填充前景色。
setSolidColor(color: string) 将形状的填充格式设置为统一颜色。
transparency 将填充的透明度百分比指定为从 0.0 (不透明) 到 1.0 (清除) 的值。
type 返回形状的填充类型。
ShapeGroup id 获取表示形状组标识符的整数。
shape 获取与组关联的 Shape 对象。
shapes 获取 Shape 对象的集合。
ungroup() 取消分组指定形状组中的任何已分组形状。
ShapeTextWrap bottomDistance 指定文档文本与指定形状周围无文本区域的下边缘之间的距离 () 磅。
leftDistance 指定文档文本与指定形状周围无文本区域的左边缘之间的距离 () 磅。
rightDistance 指定文档文本与指定形状周围无文本区域的右边缘之间的距离 (以磅为单位) 。
边 指定文档文本是应环绕在指定形状的两侧、仅在左侧或右侧，还是应环绕在距页边距最远的形状的一侧。
topDistance 指定文档文本与指定形状周围无文本区域的上边缘之间的) (距离（以磅为单位）。
type 指定形状周围的文本换行类型。
TextFrame autoSizeSetting 文本框的自动调整大小设置。
bottomMargin 表示文本框的下边距（以磅为单位）。
hasText 指定文本框是否包含文本。
leftMargin 表示文本框的左边距（以磅为单位）。
noTextRotation 如果旋转形状时，文本框架中的文本不应旋转，则返回 True。
orientation 表示文本框架所指向的角度。
rightMargin 表示文本框的右边距（以磅为单位）。
topMargin 表示文本框的上边距（以磅为单位）。
verticalAlignment 表示文本框的垂直对齐方式。
wordWrap 确定是否自动换行以适合形状内的文本。
Window activePane 获取窗口中的活动窗格。
窗 格 获取窗口中窗格的集合。
WindowCollection getFirst() 获取此集合中的第一个窗口。
getFirstOrNullObject () 获取此集合中的第一个窗口。
items 获取此集合中已加载的子项。

另请参阅