通过

Word JavaScript API 1.4 中的新增功能

WordApi 1.4 添加了对书签、更改跟踪、注释、自定义 XML 部件、字段以及合并和拆分表单元格的支持。

API 列表

下表列出了 Word JavaScript API 要求集 1.4 中的 API。 若要查看Word JavaScript API 要求集 1.4 或更低版本支持的所有 API 的 API 参考文档，请参阅要求集 1.4 或更低版本中Word API。

类 域 说明
正文 fields 获取正文中的 对象的集合 Field 。
getComments () 获取与正文关联的注释。
getReviewedText (changeTrackingVersion？： Word。ChangeTrackingVersion) 根据 ChangeTrackingVersion 选择获取审阅的文本。
Comment authorEmail 获取批注作者的电子邮件。
authorName 获取批注作者的姓名。
content 将注释的内容指定为纯文本。
contentRange 指定注释的内容范围。
creationDate 获取批注的创建日期。
delete() 删除批注及其答复。
getRange() 获取注释所在的主文档中的区域。
id 获取注释的 ID。
replies 获取与注释关联的回复对象的集合。
reply (replyText： string) 将新答复添加到注释线程的末尾。
解决 指定注释线程的状态。
CommentCollection getFirst() 获取集合中的第一个注释。
getFirstOrNullObject () 获取集合中的第一个注释。
items 获取此集合中已加载的子项。
CommentContentRange bold 指定注释文本是否为粗体。
hyperlink 获取 range 内的第一个超链接，或在 range 内设置超链接。
insertText (text： string， insertLocation： Word。InsertLocation |“Replace” |“Start” |“End” |“Before” |“After”) 将文本插入到指定位置。
isEmpty 检查 range 长度是否为零。
italic 指定是否对注释文本进行斜体化。
strikeThrough 指定注释文本是否具有删除线。
text 获取注释范围的文本。
underline 指定注释文本的下划线类型。
CommentReply authorEmail 获取批注回复作者的电子邮件。
authorName 获取批注回复作者的姓名。
content 指定批注回复的内容。
contentRange 指定 commentReply 的内容范围。
creationDate 获取批注答复的创建日期。
delete() 删除批注回复。
id 获取批注回复的 ID。
parentComment 获取此答复的父批注。
CommentReplyCollection getFirst() 获取集合中的第一个批注回复。
getFirstOrNullObject () 获取集合中的第一个批注回复。
items 获取此集合中已加载的子项。
ContentControl fields 获取内容控件中对象的集合 Field 。
getComments () 获取与内容控件关联的注释。
getReviewedText (changeTrackingVersion？： Word。ChangeTrackingVersion) 根据 ChangeTrackingVersion 选择获取审阅的文本。
CustomXmlPart delete() 删除自定义 XML 部件。
deleteAttribute (xpath： string， namespaceMappings： { [key： string]： string }， name： string) 从 xpath 标识的元素中删除具有给定名称的属性。
deleteElement (xpath： string， namespaceMappings： { [key： string]： string }) 删除 xpath 标识的元素。
getXml () 获取自定义 XML 部件的完整 XML 内容。
id 获取自定义 XML 部件的 ID。
insertAttribute (xpath： string， namespaceMappings： { [key： string]： string }， name： string， value： string) 将具有给定名称和值的特性插入 xpath 标识的元素。
insertElement (xpath： string， xml： string， namespaceMappings： { [key： string]： string }， index？： number) 在子位置索引处 xpath 标识的父元素下插入给定的 XML。
namespaceUri 获取自定义 XML 部件的命名空间 URI。
query (xpath： string， namespaceMappings： { [key： string]： string }) 查询自定义 XML 部件的 XML 内容。
setXml (xml： string) 设置自定义 XML 部件的完整 XML 内容。
updateAttribute (xpath： string， namespaceMappings： { [key： string]： string }， name： string， value： string) 汇报具有 xpath 标识的元素的给定名称的属性的值。
updateElement (xpath： string， xml： string， namespaceMappings： { [key： string]： string }) 汇报 xpath 标识的元素的 XML。
CustomXmlPartCollection add (xml： string) 向文档添加新的自定义 XML 部件。
getByNamespace (namespaceUri： string) 获取其命名空间匹配给定命名空间的自定义 XML 部件的新作用域内集合。
getCount() 获取集合中项的数目。
getItem(id: string) 获取基于其 ID 的自定义 XML 部件。
getItemOrNullObject(id: string) 获取基于其 ID 的自定义 XML 部件。
items 获取此集合中已加载的子项。
CustomXmlPartScopedCollection getCount() 获取集合中项的数目。
getItem(id: string) 获取基于其 ID 的自定义 XML 部件。
getItemOrNullObject(id: string) 获取基于其 ID 的自定义 XML 部件。
getOnlyItem () 如果集合仅包含一个项，则此方法返回该项。
getOnlyItemOrNullObject () 如果集合仅包含一个项，则此方法返回该项。
items 获取此集合中已加载的子项。
"文档" changeTrackingMode 指定 ChangeTracking 模式。
customXmlParts 获取文档中的自定义 XML 部件。
deleteBookmark (name： string) 从文档中删除书签（如果存在）。
getBookmarkRange (名称：string) 获取书签的范围。
getBookmarkRangeOrNullObject (name： string) 获取书签的范围。
设置 获取文档中加载项的设置。
Field code 指定字段的代码指令。
getNext () 获取下一个字段。
getNextOrNullObject () 获取下一个字段。
parentBody 获取字段的父正文。
parentContentControl 获取包含 字段的内容控件。
parentContentControlOrNullObject 获取包含 字段的内容控件。
parentTable 获取包含 字段的表。
parentTableCell 获取包含 字段的表单元格。
parentTableCellOrNullObject 获取包含 字段的表单元格。
parentTableOrNullObject 获取包含 字段的表。
result 获取字段的结果数据。
FieldCollection getFirst() 获取此集合中的第一个字段。
getFirstOrNullObject () 获取此集合中的第一个字段。
items 获取此集合中已加载的子项。
Paragraph fields 获取段落中字段的集合。
getComments () 获取与段落关联的注释。
getReviewedText (changeTrackingVersion？： Word。ChangeTrackingVersion) 根据 ChangeTrackingVersion 所选内容获取审阅的文本。
区域 fields 获取区域中对象的 Field 集合。
getBookmarks (includeHidden？： boolean， includeAdjacent？： boolean) 获取区域内或重叠的所有书签的名称。
getComments () 获取与区域关联的注释。
getReviewedText (changeTrackingVersion？： Word。ChangeTrackingVersion) 根据 ChangeTrackingVersion 选择获取审阅的文本。
insertBookmark (名称：字符串) 在区域上插入书签。
insertComment (commentText： string) 在区域上插入注释。
设置 delete() 删除 Setting 对象。
key 获取设置的键。
value 指定设置的值。
SettingCollection add (key： string， value： any) 创建新设置或设置现有设置。
deleteAll () 删除此加载项中的所有设置。
getCount() 获取集合中项的数目。
getItem(key: string) Setting按对象的键获取对象，该键区分大小写。
getItemOrNullObject(key: string) Setting按对象的键获取对象，该键区分大小写。
items 获取此集合中已加载的子项。
Table fields 获取表中对象的 Field 集合。
mergeCells (topRow： number， firstCell： number， bottomRow： number， lastCell： number) 合并由第一个单元格和最后一个单元格绑定的单元格。
TableCell split (rowCount： number， columnCount： number) 将单元格拆分为指定数量的行和列。
TableRow fields 获取表行中对象的集合 Field 。
merge () 将行合并到一个单元格中。

另请参阅

  • Last updated on