Word JavaScript API 1.3 的最近更新

  • 项目

WordApi 1.3 添加了对内容控件和文档级设置的更多支持。

API 列表

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

类 域 说明
Application createDocument (base64File？： string) 使用可选的 Base64 编码 .docx 文件创建新文档。
正文 getRange (rangeLocation？： Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |Word。RangeLocation.content |“整个” |“Start” |“End” |“After” |“Content”) 获取整个正文或正文的起点/终点，作为一个范围。
insertTable (rowCount： number， columnCount： number， insertLocation： Word。InsertLocation.start |Word。InsertLocation.end |“Start” |“End”， values？： string[][]) 插入包含指定行数和列数的 table。
lists 获取 body 中的一组 list 对象。
parentBody 获取 body 的父正文。
parentBodyOrNullObject 获取 body 的父正文。
parentContentControlOrNullObject 获取包含正文的内容控件。
parentSection 获取 body 的父节。
parentSectionOrNullObject 获取 body 的父节。
styleBuiltIn 指定正文的内置样式名称。
表 获取 body 中的一组 table 对象。
type 获取 body 的类型。
ContentControl getRange (rangeLocation？： Word。RangeLocation |“整个” |“Start” |“End” |“Before” |“After” |“Content”) 获取整个内容控件或内容控件的起点/终点，作为一个范围。
getTextRanges (endMarks： string[]， trimSpacing？： boolean) 使用标点符号和/或其他结束标记获取内容控件中的文本范围。
insertTable (rowCount： number， columnCount： number， insertLocation： Word。InsertLocation.start |Word。InsertLocation.end |Word。InsertLocation.before |Word。InsertLocation.after |“Start” |“End” |“Before” |“After”， values？： string[][]) 将包含指定行数和列数的 table 插入 contentControl 中或在其旁边插入。
lists 获取 contentControl 中的一组 list 对象。
parentBody 获取 contentControl 的父正文。
parentContentControlOrNullObject 获取包含此内容控件的内容控件。
parentTable 获取包含 contentControl 的 table。
parentTableCell 获取包含 contentControl 的 tableCell。
parentTableCellOrNullObject 获取包含 contentControl 的 tableCell。
parentTableOrNullObject 获取包含 contentControl 的 table。
split (delimiters： string[]， multiParagraphs？： boolean， trimDelimiters？： boolean， trimSpacing？： boolean) 使用分隔符将内容控件拆分为各个子范围。
styleBuiltIn 指定内容控件的内置样式名称。
亚 获取 contentControl 的子类型。
表 获取 contentControl 中的一组 table 对象。
ContentControlCollection getByIdOrNullObject (id： number) 按其标识符获取内容控件。
getByTypes (类型：Word。ContentControlType[]) 获取具有指定类型的内容控件。
getFirst() 获取此集合中的第一个内容控件。
getFirstOrNullObject () 获取此集合中的第一个内容控件。
CustomProperty delete() 删除 custom property 对象。
key 获取 customProperty 的键。
type 获取自定义属性的值类型。
value 指定自定义属性的值。
CustomPropertyCollection add (key： string， value： any) 新建自定义属性或设置现有自定义属性。
deleteAll () 删除此集合中的所有自定义属性。
getCount() 获取自定义属性的计数。
getItem(key: string) 按键获取自定义属性对象（不区分大小写）。
getItemOrNullObject(key: string) 按键获取自定义属性对象（不区分大小写）。
items 获取此集合中已加载的子项。
"文档" properties 获取文档的属性。
DocumentCreated open () 打开文档。
DocumentProperties applicationName 获取 document 的应用程序名称。
作者 指定文档的作者。
类别 指定文档的类别。
comments 指定文档的注释。
company 指定文档的公司。
creationDate 获取文档的创建日期。
customProperties 获取 document 的一组 customProperty。
format 指定文档的格式。
关键 字 指定文档的关键字。
lastAuthor 获取文档的最后一个作者。
lastPrintDate 获取文档的上次打印日期。
lastSaveTime 获取 document 的上次保存日期。
经理 指定文档的管理器。
revisionNumber 获取文档的修订号。
安全 获取文档的安全设置。
subject 指定文档的主题。
template 获取文档的模板。
title 指定文档的标题。
InlinePicture getNext () 获取下一个嵌入式图像。
getNextOrNullObject () 获取下一个嵌入式图像。
getRange (rangeLocation？： Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |“整个” |“Start” |“End”) 获取图片或图片的起点/终点，作为一个范围。
parentContentControlOrNullObject 获取包含嵌入式图像的内容控件。
parentTable 获取包含嵌入式图像的 table。
parentTableCell 获取包含嵌入式图像的 tableCell。
parentTableCellOrNullObject 获取包含嵌入式图像的 tableCell。
parentTableOrNullObject 获取包含嵌入式图像的 table。
InlinePictureCollection getFirst() 获取此集合中的第一个嵌入式图像。
getFirstOrNullObject () 获取此集合中的第一个嵌入式图像。
List getLevelParagraphs (level： number) 获取列表中指定级别的段落。
getLevelString (级别：数字) 获取指定级别的项目符号、编号或图片作为字符串。
id 获取列表的 ID。
insertParagraph (paragraphText： string， insertLocation： Word。InsertLocation.start |Word。InsertLocation.end |Word。InsertLocation.before |Word。InsertLocation.after |“Start” |“End” |“Before” |“After”) 在指定位置插入段落。
levelExistences 检查 list 中是否包含所有 9 个级别。
levelTypes 获取 list 中的所有 9 个级别类型。
paragraphs 获取 list 中的段落。
setLevelAlignment (level： number， alignment： Word。对齐) 设置列表中指定级别的项目符号、编号或图片的对齐方式。
setLevelBullet (level： number， listBullet： Word。ListBullet， charCode？： number， fontName？： string) 设置 list 中指定级别的项目符号格式。
setLevelIndents (level： number， textIndent： number， bulletNumberPictureIndent： number) 设置列表中指定级别的两种缩进方式。
setLevelNumbering (level： number， listNumbering： Word。ListNumbering，formatString？：数组<字符串 | number>) 设置列表中指定级别的编号格式。
setLevelStartingNumber (级别： number， startingNumber： number) 设置 list 中指定级别的起始编号。
ListCollection getById(id: number) 按标识符获取列表。
getByIdOrNullObject (id： number) 按标识符获取列表。
getFirst() 获取此集合中的第一个列表。
getFirstOrNullObject () 获取此集合中的第一个列表。
getItem (ID：数字) 按 ID 获取列表对象。
items 获取此集合中已加载的子项。
ListItem getAncestor (parentOnly？：布尔) 获取列表项父项，如果父项不存在，则获取最接近的上级。
getAncestorOrNullObject (parentOnly？： 布尔) 获取列表项父项，如果父项不存在，则获取最接近的上级。
getDescendants (directChildrenOnly？： boolean) 获取相应列表项目的所有后代列表项目。
level 指定列表中项的级别。
listString 以字符串的形式获取列表项项目符号、数字或图片。
siblingIndex 获取 listItem 相对于同级元素的序号。
Paragraph attachToList (listId： number， level： number) 将 paragraph 加入指定级别的现有 list。
detachFromList () 如果此段落是列表项目的话，从列表中移出此段落。
getNext () 获取下一个段落。
getNextOrNullObject () 获取下一个段落。
getPrevious () 获取上一个段落。
getPreviousOrNullObject () 获取上一个段落。
getRange (rangeLocation？： Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |Word。RangeLocation.content |“整个” |“Start” |“End” |“After” |“Content”) 获取整个段落或段落的起点/终点，作为一个范围。
getTextRanges (endMarks： string[]， trimSpacing？： boolean) 使用标点符号和/或其他结束标记获取段落中的文本范围。
insertTable (rowCount： number， columnCount： number， insertLocation： Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”， values？： string[][]) 插入包含指定行数和列数的 table。
isLastParagraph 指明 paragraph 是其父正文内的最后一个段落。
isListItem 检查 paragraph 是否为 listItem。
列表 获取 paragraph 所属的 List。
listItem 获取 paragraph 的 ListItem。
listItemOrNullObject 获取 paragraph 的 ListItem。
listOrNullObject 获取 paragraph 所属的 List。
parentBody 获取 paragraph 的父正文。
parentContentControlOrNullObject 获取包含段落的内容控件。
parentTable 获取包含 paragraph 的 table。
parentTableCell 获取包含 paragraph 的 tableCell。
parentTableCellOrNullObject 获取包含 paragraph 的 tableCell。
parentTableOrNullObject 获取包含 paragraph 的 table。
split (分隔符： string[]， trimDelimiters？： boolean， trimSpacing？： boolean) 使用分隔符将段落拆分为多个子范围。
startNewList () 生成包含此 paragraph 的新 list。
styleBuiltIn 指定段落的内置样式名称。
tableNestingLevel 获取 paragraph 的表级别。
ParagraphCollection getFirst() 获取此集合中的第一个段落。
getFirstOrNullObject () 获取此集合中的第一个段落。
getLast () 获取此集合中的最后一个段落。
getLastOrNullObject () 获取此集合中的最后一个段落。
区域 compareLocationWith (范围：Word。范围) 比较此范围与另一范围的位置。
expandTo (range： Word。范围) 返回从此 range 进行任一方向扩展的新 range，以便覆盖另一 range。
expandToOrNullObject (范围：Word。范围) 返回从此 range 进行任一方向扩展的新 range，以便覆盖另一 range。
getHyperlinkRanges () 获取相应范围内的超链接子范围。
getNextTextRange (endMarks： string[]， trimSpacing？： boolean) 使用标点符号和/或其他结束标记获取下一个文本区域。
getNextTextRangeOrNullObject (endMarks： string[]， trimSpacing？： boolean) 使用标点符号和/或其他结束标记获取下一个文本区域。
getRange (rangeLocation？： Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |Word。RangeLocation.content |“整个” |“Start” |“End” |“After” |“Content”) 克隆相应范围，或获取该范围的起点/终点作为一个新范围。
getTextRanges (endMarks： string[]， trimSpacing？： boolean) 使用标点符号和/或其他结束标记获取区域中的文本子区域。
hyperlink 获取 range 内的第一个超链接，或在 range 内设置超链接。
insertTable (rowCount： number， columnCount： number， insertLocation： Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”， values？： string[][]) 插入包含指定行数和列数的 table。
intersectWith (范围：Word。范围) 返回新 range 作为此 range 与另一 range 的交集。
intersectWithOrNullObject (范围：Word。范围) 返回新 range 作为此 range 与另一 range 的交集。
isEmpty 检查 range 长度是否为零。
lists 获取 range 中的一组 list 对象。
parentBody 获取 range 的父正文。
parentContentControlOrNullObject 获取包含该范围的内容控件。
parentTable 获取包含 range 的 table。
parentTableCell 获取包含 range 的 tableCell。
parentTableCellOrNullObject 获取包含 range 的 tableCell。
parentTableOrNullObject 获取包含 range 的 table。
split (delimiters： string[]， multiParagraphs？： boolean， trimDelimiters？： boolean， trimSpacing？： boolean) 使用分隔符将相应范围拆分为各个子范围。
styleBuiltIn 指定区域的内置样式名称。
表 获取 range 中的一组 table 对象。
RangeCollection getFirst() 获取此集合中的第一个范围。
getFirstOrNullObject () 获取此集合中的第一个范围。
RequestContext application [Api 集：WordApi 1.3] *
Section getNext () 获取下一节。
getNextOrNullObject () 获取下一节。
SectionCollection getFirst() 获取此集合中的第一节。
getFirstOrNullObject () 获取此集合中的第一节。
Table addColumns (insertLocation： Word。InsertLocation.start |Word。InsertLocation.end |“Start” |“End”， columnCount： number， values？： string[][]) 使用第一个或最后一个现有列作为模板，将列添加到 table 的开头或结尾。
addRows (insertLocation： Word。InsertLocation.start |Word。InsertLocation.end |“Start” |“End”， rowCount： number， values？： string[][]) 使用第一个或最后一个现有行作为模板，将行添加到 table 的开头或结尾。
对准 指定表与页面列的对齐方式。
autoFitWindow () 自动调整表列，以适应窗口的宽度。
clear() 清除表内容。
delete() 删除整个表格。
deleteColumns (columnIndex： number， columnCount？： number) 删除特定的列。
deleteRows (rowIndex： number， rowCount？： number) 删除特定的行。
distributColumns () 将列设置为等宽。
font 获取字体。
getBorder (borderLocation： Word。BorderLocation) 获取指定边框的边框样式。
getCell(rowIndex: number, cellIndex: number) 获取指定行和列处的表单元格。
getCellOrNullObject (rowIndex： number， cellIndex： number) 获取指定行和列处的表单元格。
getCellPadding (cellPaddingLocation：Word。CellPaddingLocation) 获取单元格填充（以磅为单位）。
getNext () 获取下一个表格。
getNextOrNullObject () 获取下一个表格。
getParagraphAfter () 获取 table 之后的 paragraph。
getParagraphAfterOrNullObject () 获取 table 之后的 paragraph。
getParagraphBefore () 获取 table 之前的 paragraph。
getParagraphBeforeOrNullObject () 获取 table 之前的 paragraph。
getRange (rangeLocation？： Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |“整个” |“Start” |“End” |“After”) 获取包含此表格的范围，或包含此表格的开头或结尾的范围。
headerRowCount 指定标题行数。
horizontalAlignment 指定表格中每个单元格的水平对齐方式。
insertContentControl() 在表格中插入内容控件。
insertParagraph (paragraphText： string， insertLocation： Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”) 在指定位置插入段落。
insertTable (rowCount： number， columnCount： number， insertLocation： Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”， values？： string[][]) 插入包含指定行数和列数的 table。
isUniform 指明所有表行是否一致。
nestingLevel 获取 table 的嵌套级别。
parentBody 获取 table 的父正文。
parentContentControl 获取包含 table 的 contentControl。
parentContentControlOrNullObject 获取包含 table 的 contentControl。
parentTable 获取包含此 table 的 table。
parentTableCell 获取包含此 table 的 tableCell。
parentTableCellOrNullObject 获取包含此 table 的 tableCell。
parentTableOrNullObject 获取包含此 table 的 table。
rowCount 获取表格中的行数。
rows 获取所有表格行。
search (searchText： string， searchOptions？： Word。SearchOptions |{ ignorePunct？： boolean ignoreSpace？： boolean matchCase？： boolean matchPrefix？： boolean matchSuffix？： boolean matchWholeWord？： boolean matchWildcards？： boolean }) 对表对象的作用域使用指定的 SearchOptions 执行搜索。
选择 (selectionMode？： Word。SelectionMode) 选择表格或其开头或结尾位置，然后将 Word UI 导航到相应位置。
setCellPadding (cellPaddingLocation：Word。CellPaddingLocation，cellPadding：数字) 设置单元格填充（以磅为单位）。
shadingColor 指定底纹颜色。
style 指定表的样式名称。
styleBandedColumns 指定表是否具有带状列。
styleBandedRows 指定表是否具有带带行。
styleBuiltIn 指定表的内置样式名称。
styleFirstColumn 指定表是否具有具有特殊样式的第一列。
styleLastColumn 指定表是否具有具有特殊样式的最后一列。
styleTotalRow 指定表是否具有具有特殊样式的最后一) 行的总 (。
表 获取嵌套一级的子 table。
values 将表中的文本值指定为 2D JavaScript 数组。
verticalAlignment 指定表格中每个单元格的垂直对齐方式。
width 指定表的宽度（以磅为单位）。
TableBorder color 指定表格边框颜色。
type 指定表格边框的类型。
width 指定表格边框的宽度（以磅为单位）。
TableCell body 获取单元格的 body 对象。
cellIndex 获取单元格行中的单元格索引。
columnWidth 指定单元格列的宽度（以磅为单位）。
deleteColumn () 删除包含该单元格的列。
deleteRow () 删除包含该单元格的行。
getBorder (borderLocation： Word。BorderLocation) 获取指定边框的边框样式。
getCellPadding (cellPaddingLocation：Word。CellPaddingLocation) 获取单元格填充（以磅为单位）。
getNext () 获取下一个单元格。
getNextOrNullObject () 获取下一个单元格。
horizontalAlignment 指定单元格的水平对齐方式。
insertColumns (insertLocation：Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”， columnCount： number， values？： string[][]) 使用单元格的列作为模板，在单元格的左侧或右侧添加列。
insertRows (insertLocation： Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”， rowCount： number， values？： string[][]) 使用单元格的行作为模板，在单元格的上方或下方插入行。
parentRow 获取单元格的父行。
parentTable 获取单元格的父表。
rowIndex 获取表中单元格行的索引。
setCellPadding (cellPaddingLocation：Word。CellPaddingLocation，cellPadding：数字) 设置单元格填充（以磅为单位）。
shadingColor 指定单元格的底纹颜色。
value 指定单元格的文本。
verticalAlignment 指定单元格的垂直对齐方式。
width 获取单元格的宽度（以磅为单位）。
TableCellCollection getFirst() 获取此集合中的第一个表格单元格。
getFirstOrNullObject () 获取此集合中的第一个表格单元格。
items 获取此集合中已加载的子项。
TableCollection getFirst() 获取此集合中的第一个表格。
getFirstOrNullObject () 获取此集合中的第一个表格。
items 获取此集合中已加载的子项。
TableRow cellCount 获取行中的单元格数。
细胞 获取单元格。
clear() 清除行内容。
delete() 删除整行。
font 获取字体。
getBorder (borderLocation： Word。BorderLocation) 获取行中单元格的边框样式。
getCellPadding (cellPaddingLocation：Word。CellPaddingLocation) 获取单元格填充（以磅为单位）。
getNext () 获取下一行。
getNextOrNullObject () 获取下一行。
horizontalAlignment 指定行中每个单元格的水平对齐方式。
insertRows (insertLocation： Word。InsertLocation.before |Word。InsertLocation.after |“Before” |“After”， rowCount： number， values？： string[][]) 使用此行作为模板插入行。
isHeader 检查该行是否为标题行。
parentTable 获取父表。
preferredHeight 指定行的首选高度（以磅为单位）。
rowIndex 获取其父表中的行索引。
search (searchText： string， searchOptions？： Word。SearchOptions |{ ignorePunct？： boolean ignoreSpace？： boolean matchCase？： boolean matchPrefix？： boolean matchSuffix？： boolean matchWholeWord？： boolean matchWildcards？： boolean }) 对行范围使用指定的 SearchOptions 执行搜索。
选择 (selectionMode？： Word。SelectionMode) 选择行，然后将 Word UI 导航到相应位置。
setCellPadding (cellPaddingLocation：Word。CellPaddingLocation，cellPadding：数字) 设置单元格填充（以磅为单位）。
shadingColor 指定底纹颜色。
values 指定行中的文本值，作为 2D JavaScript 数组。
verticalAlignment 指定行中单元格的垂直对齐方式。
TableRowCollection getFirst() 获取此集合中的第一行。
getFirstOrNullObject () 获取此集合中的第一行。
items 获取此集合中已加载的子项。

另请参阅