通过

Word JavaScript 预览 API

新Word JavaScript API 首先在“预览版”中引入，然后在进行足够的测试并获取用户反馈后成为特定编号要求集的一部分。

重要

请注意，以下Word预览 API 可能在以下平台上可用。

  • Windows 版 Word
  • Mac 版 Word

iPad 目前不支持Word预览 API。 但是，多个 API 可能仅在 web 上的Word中可用。

注意

预览 API 可能会发生变更，不适合在生产环境中使用。 我们建议你仅在测试和开发环境中试用它们。 不要在生产环境或业务关键型文档中使用预览 API。

若要使用预览 API：

API 列表

下表列出了当前处于预览状态Word JavaScript API。 若要查看所有Word JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅所有Word JavaScript API。

类 域 说明
正文 onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeleted 删除批注时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
type 获取 body 的类型。
BookmarkCollection add (name： string， range： Word。范围) 返回一个 Bookmark 对象，该对象表示添加到区域的书签。
getItem(index: number) Bookmark按对象在集合中的索引获取对象。
BorderUniversalCollection getItem(index: number) Border按对象在集合中的索引获取对象。
CommentDetail id 表示此注释的 ID。
replyIds 表示对此批注的答复的 ID。
CommentEventArgs changeType 表示如何 commentChanged 引发事件。
commentDetails 获取包含 CommentDetail 所涉及注释的 ID 和答复 ID 的数组。
源 事件的源。
type 事件类型。
ConflictCollection getItem(index: number) Conflict按对象在集合中的索引获取对象。
ContentControl onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
resetState () 重置内容控件的状态。
setState (contentControlState： Word。ContentControlState) 设置内容控件的状态。
CustomXmlAddValidationErrorOptions clearedOnUpdate 如果提供，则指定是否要从Word清除错误。更正和更新 XML 时 CustomXmlValidationErrorCollection。
errorText 如果提供，则指定描述性错误文本。
CustomXmlNodeCollection getItem(index: number) 返回一个 CustomXmlNode 对象，该对象代表集合中的指定项。
CustomXmlPart errors 获取一个 CustomXmlValidationErrorCollection 对象，该对象提供对任何 XML 验证错误的访问权限。
CustomXmlPrefixMappingCollection getItem(index: number) 返回一个 CustomXmlPrefixMapping 对象，该对象代表集合中的指定项。
CustomXmlValidationError delete() 删除此 CustomXmlValidationError 对象。
errorCode 获取表示 对象中的 CustomXmlValidationError 验证错误的整数。
名称 获取 对象中 CustomXmlValidationError 错误的名称。
节点 获取与此 CustomXmlValidationError 对象关联的节点（如果有）。
text 获取 对象中的 CustomXmlValidationError 文本。
type 获取从 CustomXmlValidationError 对象生成的错误类型。
CustomXmlValidationErrorCollection 添加 (节点：Word。CustomXmlNode，errorName： string， options？： Word。CustomXmlAddValidationErrorOptions) CustomXmlValidationError将包含 XML 验证错误的 对象添加到 对象CustomXmlValidationErrorCollection。
getCount() 返回集合中的项数。
getItem(index: number) 返回一个 CustomXmlValidationError 对象，该对象代表集合中的指定项。
items 获取此集合中已加载的子项。
"文档" checkIn (选项？：Word。DocumentCheckInOptions) 将文档从本地计算机签入到服务器，并将本地文档设置为只读，以便无法在本地编辑文档。
checkInWithVersion (选项？：Word。DocumentCheckInWithVersionOptions) 将文档从本地计算机保存到服务器，并将本地文档设置为只读，以便无法在本地编辑。
checkSpelling (options？： Word。DocumentCheckSpellingOptions) 开始文档的拼写检查。
computeStatistics (统计信息：Word。StatisticType， includeFootnotesAndEndnotes？： boolean) 返回基于文档内容的统计信息。
countNumberedItems (选项？：Word。DocumentCountNumberedItemsOptions) 返回文档中项目符号或编号项和 LISTNUM 字段的数目。
endReview (选项？：Word。DocumentEndReviewOptions) 终止对已发送以供审阅的文件的审阅。
exportAsFixedFormat (outputFileName： string， exportFormat： Word。ExportFormat，选项？：Word。DocumentExportAsFixedFormatOptions) 以 PDF 或 XPS 格式保存文档。
exportAsFixedFormat2 (outputFileName： string， exportFormat： Word。ExportFormat，选项？：Word。DocumentExportAsFixedFormat2Options) 以 PDF 或 XPS 格式保存文档。
exportAsFixedFormat3 (outputFileName： string， exportFormat： Word。ExportFormat，选项？：Word。DocumentExportAsFixedFormat3Options) 使用改进的标记以 PDF 或 XPS 格式保存文档。
followHyperlink (选项？：Word。DocumentFollowHyperlinkOptions) 如果缓存文档已被下载，本方法将其显示出来。
getRange (选项？：Word。DocumentRangeOptions) Range使用指定的起始字符和结束字符位置返回 对象。
goTo (选项？：Word。GoToOptions) 返回一个 Range 对象，该对象表示指定项（如页面、书签或字段）的起始位置。
merge (fileName： string， options？： Word。DocumentMergeOptions) 将文档中用修订标记标识的修改合并到另一篇文档。
printOut (选项？：Word。DocumentPrintOutOptions) 打印文档的全部或部分内容。
保护 (类型：Word。ProtectionType，选项？：Word。DocumentProtectOptions) 保护文档免受未经授权的更改。
replyWithChanges (选项？：Word。DocumentReplyWithChangesOptions) 向已发送以供审阅的文档的作者发送电子邮件，通知他们审阅者已完成对文档的审阅。
sendFaxOverInternet (选项？：Word。DocumentSendFaxOverInternetOptions) 将文档发送给传真服务提供商，后者将文档传真给一个或多个指定的收件人。
sendForReview (选项？：Word。DocumentSendForReviewOptions) 在电子邮件中发送文档，供指定收件人审阅。
DocumentCheckInOptions comment 如果提供，则指定检查作的注释。
makePublic 如果提供，则指定是否在检查后公开文档。
saveChanges 如果提供，则指定是否在签入前保存更改。
DocumentCheckInWithVersionOptions comment 如果提供，则指定检查作的注释。
makePublic 如果提供，则指定是否在检查后公开文档。
saveChanges 如果提供，则指定是否在签入前保存更改。
versionType 如果提供，则指定检查的版本类型。
DocumentCheckSpellingOptions alwaysSuggest 如果提供，则指定是否始终建议拼写更正。
customDictionary10 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary2 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary3 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary4 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary5 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary6 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary7 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary8 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary9 如果提供，则指定用于拼写检查的其他自定义词典。
customDictionary 如果提供，则指定用于拼写检查的自定义词典。
ignoreUppercase 如果提供，则指定在拼写检查期间是否忽略大写单词。
DocumentCountNumberedItemsOptions level 如果提供，则指定要计数的编号级别。
numberType 如果提供，则指定要计数的编号项的类型。
DocumentEndReviewOptions includeAttachment 如果提供，则指定是否将文档作为附件包含在内。
recipients 如果提供，则指定要在结束评审时通知的收件人。
showMessage 如果已提供，则指定是否在发送前显示消息。
subject 如果已提供，则指定通知电子邮件的主题。
DocumentExportAsFixedFormat2Options bitmapMissingFonts 如果提供，则指定是否对缺少的字体进行位图。
createBookmarks 如果提供，则指定书签创建模式。
documentStructureTags 如果提供，则指定是否包括文档结构标记。
fixedFormatExtClassPtr 如果提供，则指定扩展类指针。
from 如果提供，则指定起始页码。
includeDocProps 如果提供，则指定是否包含文档属性。
项 如果提供，则指定要导出的项。
keepInformationRightsManagement 如果提供，则指定是否保留信息权限管理 (IRM) 设置。
openAfterExport 如果已提供，则指定是否在导出后打开文件。
optimizeFor 如果提供，则指定导出的优化目标。
optimizeForImageQuality 如果提供，则指定是否针对导出文件中的图像质量进行优化。
range 如果提供，则指定要导出的范围。
to 如果提供，则指定结束页码。
useIso19005_1 如果提供，则指定是否使用 ISO 19005-1 符合性。
DocumentExportAsFixedFormat3Options bitmapMissingFonts 如果提供，则指定是否对缺少的字体进行位图。
createBookmarks 如果提供，则指定书签创建模式。
documentStructureTags 如果提供，则指定是否包括文档结构标记。
fixedFormatExtClassPtr 如果提供，则指定扩展类指针。
from 如果提供，则指定起始页码。
improveExportTagging 如果提供，则指定 改进导出标记以提高辅助功能。
includeDocProps 如果提供，则指定是否包含文档属性。
项 如果提供，则指定要导出的项。
keepInformationRightsManagement 如果提供，则指定是否保留信息权限管理 (IRM) 设置。
openAfterExport 如果已提供，则指定是否在导出后打开文件。
optimizeFor 如果提供，则指定导出的优化目标。
optimizeForImageQuality 如果提供，则指定是否针对导出文件中的图像质量进行优化。
range 如果提供，则指定要导出的范围。
to 如果提供，则指定结束页码。
useIso19005_1 如果提供，则指定是否使用 ISO 19005-1 符合性。
DocumentExportAsFixedFormatOptions bitmapMissingFonts 如果提供，则指定是否对缺少的字体进行位图。
createBookmarks 如果提供，则指定书签创建模式。
documentStructureTags 如果提供，则指定是否包括文档结构标记。
fixedFormatExtensionClassPointer 如果提供，则指定扩展类指针。
from 如果提供，则指定起始页码。
includeDocProps 如果提供，则指定是否包含文档属性。
项 如果提供，则指定要导出的项。
keepInformationRightsManagement 如果提供，则指定是否保留信息权限管理 (IRM) 设置。
openAfterExport 如果已提供，则指定是否在导出后打开文件。
optimizeFor 如果提供，则指定导出的优化目标。
range 如果提供，则指定要导出的范围。
to 如果提供，则指定结束页码。
useIso19005_1 如果提供，则指定是否使用 ISO 19005-1 符合性。
DocumentFollowHyperlinkOptions addHistory 如果提供，则指定是否将链接添加到浏览历史记录。
address 如果提供，则指定要遵循的超链接地址。
extraInfo 如果提供，则指定要随请求一起传递的其他信息。
headerInfo 如果提供，则指定 HTTP 请求的标头信息。
httpMethod 如果提供，则指定用于请求的 HTTP 方法。
newWindow 如果提供，则指定是否在新窗口中打开链接。
subAddress 如果提供，则指定文档中的子地址。
DocumentMergeOptions addToRecentFiles 如果提供，则指定是否将合并的文档添加到最近使用的文件。
detectFormatChanges 如果提供，则指定是否在合并期间检测格式更改。
mergeTarget 如果提供，则指定合并作的目标。
useFormattingFrom 如果提供，则指定在合并中使用的格式设置源。
DocumentPrintOutOptions activePrinterMacGX 如果提供，则指定打印机名称。
附加 如果已提供，则指定是否追加到现有文件。
背景 如果提供，则指定是否在背景中打印。
整理 如果提供，则指定是否整理页面。
副本 如果提供，则指定要打印的副本数。
from 如果提供，则指定起始页码。
项 如果已提供，则指定要打印的项。
manualDuplexPrint 如果提供，则指定是否手动双面打印。
outputFileName 如果提供，则指定输出文件的名称。
pageType 如果提供，则指定页面顺序。
pages 如果提供，则指定要打印的特定页面。
printToFile 如果提供，则指定是否打印到文件。
printZoomColumn 如果提供，则指定缩放列设置。
printZoomPaperHeight 如果提供，则指定打印的纸张高度（以 twips (20 twips = 1 磅为单位）;72 分 = 1 英寸) 。
printZoomPaperWidth 如果提供，则指定打印的纸张宽度，以 twips (20 twips = 1 磅;72 分 = 1 英寸) 。
printZoomRow 如果提供，则指定缩放行设置。
range 如果提供，则指定要打印的区域。
to 如果提供，则指定结束页码。
DocumentProtectOptions enforceStyleLock 如果提供，则指定是否强制实施样式锁限制。
noReset 如果提供，则指定在保护文档时是否重置窗体字段。
password 如果提供，则指定用于文档保护的密码。
useInformationRightsManagement 如果提供，则指定是否使用信息权限管理 (IRM) 。
DocumentRangeOptions end 如果已提供，则指定结束字符位置。
start 如果已提供，则指定起始字符位置。
DocumentReplyWithChangesOptions includeAttachment 如果提供，则指定是否将文档作为附件包含在内。
recipients 如果提供，则指定答复的收件人。
showMessage 如果已提供，则指定是否在发送前显示消息。
subject 如果提供，则指定答复电子邮件的主题。
DocumentSendFaxOverInternetOptions recipients 如果提供，则指定传真的收件人。
showMessage 如果已提供，则指定是否在发送前显示消息。
subject 如果提供，则指定传真的主题。
DocumentSendForReviewOptions includeAttachment 如果提供，则指定是否将文档作为附件包含在内。
recipients 如果提供，则指定审阅请求的收件人。
showMessage 如果已提供，则指定是否在发送前显示消息。
subject 如果提供，则指定审阅电子邮件的主题。
GoToOptions count 如果提供，则指定文档中项的编号。
方向 如果已提供，则指定范围或选定内容的移动方向。
项 如果已提供，则指定将范围或选定内容移动到的项类型。
名称 如果已提供，则指定属性设置为 Word 的名称item。GoToItem 类型 bookmark、comment、 field或 object。
IndexCollection getItem(index: number) Index按对象在集合中的索引获取对象。
ListTemplateAddOptions 名称 如果提供，则指定要添加的列表模板的名称。
outlineNumbered 如果已提供，则指定是否对新列表模板应用大纲编号。
ListTemplateCollection 添加 (选项？：Word。ListTemplateAddOptions) ListTemplate添加新对象。
getItem(index: number) ListTemplate按对象在集合中的索引获取对象。
ListTemplateGalleryCollection getItem(index: number) ListTemplateGallery按对象在集合中的索引获取对象。
Paragraph onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeleted 删除批注时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
区域 onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
underline 指定应用于区域的下划线类型。
RangeScopedCollection getItem(index: number) Range按对象在集合中的索引获取对象。
RepeatingSectionContentControl xmlMapping 返回一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。
ReviewerCollection getItem(index: number) 返回一个 Reviewer 对象，该对象代表集合中的指定项。
RevisionCollection getItem(index: number) 返回一个 Revision 对象，该对象代表集合中的指定项。
Selection convertToTable (选项？：Word。SelectionConvertToTableOptions) 将范围内的文本转换为表格。
goTo (选项？：Word。GoToOptions) 返回一个 Range 对象，该对象代表 指定的 options 区域，并将插入点移动到紧靠在指定项前面的字符位置。
SelectionConvertToTableOptions applyBorders 如果提供，则指定是否对指定格式的表应用边框。
applyColor 如果提供，则指定是否对指定格式的表应用颜色格式。
applyFirstColumn 如果提供，则指定是否对指定格式的第一列应用特殊格式。
applyFont 如果提供，则指定是否对指定格式的表应用字体格式。
applyHeadingRows 如果提供，则指定是否将第一行的格式设置为指定格式的标题行。
applyLastColumn 如果提供，则指定是否对指定格式的最后一列应用特殊格式。
applyLastRow 如果提供，则指定是否对指定格式的最后一行应用特殊格式。
applyShading 如果已提供，则指定是否对指定格式的表应用底纹。
autoFit 如果提供，则指定是否自动调整表格大小以适应内容。
autoFitBehavior 如果提供，则指定表的自动拟合行为。
defaultTableBehavior 如果提供，则指定Microsoft Word是否自动调整表格中的单元格大小以适应内容。
format 如果提供，则指定要应用于表的预设格式。
initialColumnWidth 如果提供，则指定表中每列的初始宽度（以磅为单位）。
numColumns 如果提供，则指定表中的列数。
numRows 如果提供，则指定表中的行数。
分隔符 如果提供，则指定用于将文本分隔为单元格的字符。
SourceCollection getItem(index: number) Source按集合中的索引获取 。
样式 description 获取样式的说明。
TabStopCollection getItem(index: number) TabStop按对象在集合中的索引获取对象。
Window state 指定文档窗口或任务窗口的状态。
XmlNode type 获取节点的类型。
value 指定此 XML 节点的值。
XmlNodeCollection getItem(index: number) XmlNode按对象在集合中的索引获取对象。

另请参阅

  • Last updated on