通过

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：

API 列表

下表列出了当前处于预览状态Word JavaScript API，但仅在 web 上的 Word 中可用的 API 除外。 若要查看所有Word JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅所有Word JavaScript API。

类 域 说明
正文 shapes 获取正文中形状对象的集合，包括内联形状和浮动形状。
type 获取 body 的类型。
ContentControl resetState () 重置内容控件的状态。
setState (contentControlState： Word。ContentControlState) 设置内容控件的状态。
ContentControlAddedEventArgs eventType 事件类型。
ContentControlDataChangedEventArgs eventType 事件类型。
ContentControlDeletedEventArgs eventType 事件类型。
ContentControlEnteredEventArgs eventType 事件类型。
ContentControlExitedEventArgs eventType 事件类型。
ContentControlSelectionChangedEventArgs eventType 事件类型。
"文档" compareFromBase64 (base64File： string， documentCompareOptions？： Word。DocumentCompareOptions) 显示修订标记，以表明指定的文档与另一个文档的区别。
Font hidden 指定一个值，该值指示字体是否标记为隐藏。
InsertShapeOptions height 表示要插入的形状的高度。
left 表示要插入的形状的左侧位置。
top 表示要插入的形状的顶部位置。
width 表示要插入的形状的宽度。
Paragraph insertGeometricShape (geometricShapeType：Word。GeometricShapeType， insertShapeOptions？： Word。InsertShapeOptions) 在段落开头插入一个几何形状及其定位点。
insertPictureFromBase64 (base64EncodedImage： string， insertShapeOptions？： Word。InsertShapeOptions) 在段落开头插入带有定位点的浮动图片。
insertTextBox (text？： string， insertShapeOptions？： Word。InsertShapeOptions) 在段落开头插入带有定位点的浮动文本框。
shapes 获取在段落中定位的形状对象的集合，包括内联形状和浮动形状。
ParagraphAddedEventArgs type 事件类型。
ParagraphChangedEventArgs type 事件类型。
ParagraphDeletedEventArgs type 事件类型。
区域 insertGeometricShape (geometricShapeType：Word。GeometricShapeType， insertShapeOptions？： Word。InsertShapeOptions) 在范围的开头插入一个几何形状及其定位点。
insertPictureFromBase64 (base64EncodedImage： string， insertShapeOptions？： Word。InsertShapeOptions) 在范围开头插入带有其定位点的浮动图片。
insertTextBox (text？： string， insertShapeOptions？： Word。InsertShapeOptions) 在范围开头插入一个浮动文本框及其定位点。
shapes 获取在范围中定位的形状对象的集合，包括内联形状和浮动形状。
Shape body 表示形状的正文对象。
delete() 删除形状及其内容。
geometricShapeType 形状的几何形状类型。
height 形状的高度（以磅为单位）。
id 获取表示形状标识符的整数。
left 从形状左侧到水平相对位置的距离（以磅为单位），请参阅Word。RelativeHorizontalPosition。
moveHorizontally (distance： number) 按磅数水平移动形状。
moveVertically (distance： number) 按磅数垂直移动形状。
名称 形状的名称。
relativeHorizontalPosition 形状的相对水平位置。
relativeVerticalPosition 形状的相对垂直位置。
select (selectMultipleShapes？： boolean) 选择形状。
shapeGroup 获取与形状关联的形状组。
top 从形状的上边缘到垂直相对位置的距离（以磅为单位），请参阅Word。RelativeVerticalPosition。
type 获取形状类型。
width 形状的宽度（以磅为单位）。
ShapeCollection getByGeometricTypes (类型：Word。GeometricShapeType[]) 获取具有指定几何类型的形状。
getById(id: number) 按标识符获取形状。
getByIdOrNullObject (id： number) 按标识符获取形状。
getByIds (ids： number[]) 按标识符获取形状。
getByTypes (类型：Word。ShapeType[]) 获取具有指定类型的形状。
getFirst() 获取此集合中的第一个形状。
getFirstOrNullObject () 获取此集合中的第一个形状。
组 () 组此集合中的浮动形状，将跳过内联形状。
items 获取此集合中已加载的子项。
ShapeGroup id 获取表示形状组标识符的整数。
shape 获取与组关联的 Shape 对象。
shapes 获取 Shape 对象的集合。
unGroup () 取消分组指定形状组中的任何已分组形状。
样式 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 在选择批注时发生。

另请参阅