通过

Word JavaScript API 1.5 中的新增功能

WordApi 1.5 添加了对脚注、尾注、内容控件事件和样式管理的支持。

API 列表

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

类 域 说明
Application retrieveStylesFromBase64 (base64File： string) 分析模板 Base64 文件中的样式，并将检索到的样式的 JSON 格式作为字符串返回。
正文 尾注 获取正文中的尾注集合。
脚注 获取正文中的脚注集合。
getContentControls (选项？：Word。ContentControlOptions) 获取正文中当前支持的内容控件。
ContentControl 尾注 获取内容控件中尾注的集合。
脚注 获取内容控件中的脚注集合。
getContentControls (选项？：Word。ContentControlOptions) 获取此内容控件中当前支持的子内容控件。
onDataChanged 在更改内容控件中的数据时发生。
onDeleted 删除内容控件时发生。
onEntered 在输入内容控件时发生。
onExited 在退出内容控件时发生，例如，当光标离开内容控件时。
onSelectionChanged 更改内容控件中的选择时发生。
ContentControlAddedEventArgs eventType 事件类型。
ids 获取内容控件 ID。
源 事件的源。
ContentControlCollection getByChangeTrackingStates (changeTrackingStates： Word。ChangeTrackingState[]) 获取具有指定跟踪状态的内容控件。
ContentControlDataChangedEventArgs eventType 事件类型。
ids 获取内容控件 ID。
源 事件的源。
ContentControlDeletedEventArgs eventType 事件类型。
ids 获取内容控件 ID。
源 事件的源。
ContentControlEnteredEventArgs eventType 事件类型。
ids 获取内容控件 ID。
源 事件的源。
ContentControlExitedEventArgs eventType 事件类型。
ids 获取内容控件 ID。
源 事件的源。
ContentControlOptions types 内容控件类型的数组，项必须是 richText、、plainText、checkBox、dropDownList、buildingBlockGallerycomboBox、datePicker、repeatingSection、、 picture或 group。
ContentControlSelectionChangedEventArgs eventType 事件类型。
ids 获取内容控件 ID。
源 事件的源。
"文档" addStyle (name： string， type： Word。StyleType) 按名称和类型向文档中添加样式。
close (closeBehavior？：Word。CloseBehavior) 关闭当前文档。
getContentControls (选项？：Word。ContentControlOptions) 获取文档中当前支持的内容控件。
getEndnoteBody () 获取单个正文中的文档尾注。
getFootnoteBody () 获取单个正文中的文档脚注。
getStyles () 获取一个 StyleCollection 对象，该对象表示文档的整个样式集。
insertFileFromBase64 (base64File： string， insertLocation： Word。InsertLocation.replace |Word。InsertLocation.start |Word。InsertLocation.end |“Replace” |“Start” |“End”， insertFileOptions？： Word。InsertFileOptions) 使用其他属性将文档插入到目标文档中的特定位置。
onContentControlAdded 在添加内容控件时发生。
Field data 指定类型的字段中 addin 的数据。
delete() 删除字段。
Kind 获取字段的类型。
locked 指定是否锁定字段。
选择 (selectionMode？： Word。SelectionMode) 选择字段。
type 获取字段的类型。
updateResult () 汇报字段。
FieldCollection getByTypes (类型：Word。FieldType[]) 获取对象， FieldCollection 包括指定类型的字段。
InsertFileOptions importChangeTrackingMode 如果已提供，则指定是否应从源文档导入更改跟踪模式状态。
importPageColor 如果提供，则指定是否应导入源文档中的页面颜色和其他背景信息。
importParagraphSpacing 如果提供，则指定是否应导入源文档中的段落间距。
importStyles 如果提供，则指定是否应导入源文档中的样式。
importTheme 如果提供，则指定是否应从源文档导入主题。
NoteItem body 表示注释项的正文对象。
delete() 删除注释项。
getNext () 获取相同类型的下一个注释项。
getNextOrNullObject () 获取相同类型的下一个注释项。
reference 表示主文档中的脚注或尾注引用。
type 表示备注项类型：脚注或尾注。
NoteItemCollection getFirst() 获取此集合中的第一个注释项。
getFirstOrNullObject () 获取此集合中的第一个注释项。
items 获取此集合中已加载的子项。
Paragraph 尾注 获取段落中的尾注集合。
脚注 获取段落中的脚注集合。
getContentControls (选项？：Word。ContentControlOptions) 获取段落中当前支持的内容控件。
ParagraphFormat 对准 指定指定段落的对齐方式。
firstLineIndent 指定第一行或悬挂缩进 (以磅为单位的值) 。
keepTogether 指定当Microsoft Word重新分类文档时，指定段落中的所有行是否都保留在同一页上。
keepWithNext 指定当Microsoft Word重新分类文档时，指定的段落是否与它后面的段落保持在同一页上。
leftIndent 指定左缩进。
lineSpacing 指定指定段落的行距 (（以磅为单位) ）。
lineUnitAfter 指定在指定段落之后) 网格线中的间距 (量。
lineUnitBefore 指定在指定段落之前) 网格线中的间距 (量。
mirrorIndents 指定左缩进和右缩进的宽度是否相同。
outlineLevel 指定指定段落的大纲级别。
rightIndent 指定指定段落的右缩进 (（以磅为单位) ）。
spaceAfter 指定指定段落或文本列后) (磅的间距量。
spaceBefore 指定指定段落前 () 磅的间距。
widowControl 指定当Microsoft Word重新分类文档时，指定段落中的第一行和最后一行是否与段落的其余部分保持在同一页上。
区域 尾注 获取区域中尾注的集合。
脚注 获取区域中脚注的集合。
getContentControls (选项？：Word。ContentControlOptions) 获取区域中当前支持的内容控件。
insertEndnote (insertText？： string) 插入尾注。
insertField (insertLocation：Word。InsertLocation |“Replace” |“Start” |“End” |“Before” |“After”， fieldType？： Word。FieldType， text？： string， removeFormatting？： boolean) 在指定位置插入字段。
insertFootnote (insertText？： string) 插入脚注。
样式 baseStyle 指定要用作另一个样式的基本格式的现有样式的名称。
内置 获取样式是否为内置样式。
delete() 删除样式。
font 获取一个 Font 对象，该对象表示样式的字符格式。
inUse 获取样式是已在文档中修改或应用的内置样式，还是已在文档中创建的新样式。
联系 获取样式是否为可用于段落和字符格式的链接样式。
nameLocal 获取用户语言样式的名称。
nextParagraphStyle 指定要自动应用于新段落的样式名称，该段落在用样式设置格式的段落之后插入。
paragraphFormat 获取一个 ParagraphFormat 对象，该对象表示样式的段落设置。
优先权 指定优先级。
quickStyle 指定样式是否对应于可用的快速样式。
type 获取样式类型。
unhideWhenUsed 指定在文档中使用样式后，该样式是否在样式库和Word Microsoft样式任务窗格中显示为推荐样式。
能见度 指定样式在“样式”库和“样式”任务窗格中是否显示为推荐样式。
StyleCollection getByName(name: string) Style按名称获取对象。
getByNameOrNullObject (name： string) 如果相应的样式不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。
getCount() 返回集合中的项数。
getItem(index: number) Style按对象在集合中的索引获取对象。
items 获取此集合中已加载的子项。
Table 尾注 获取表中尾注的集合。
脚注 获取表中脚注的集合。
TableRow 尾注 获取表行中的尾注集合。
脚注 获取表行中的脚注集合。

另请参阅

  • Last updated on