跳到主要内容

Api

表示 Api 类。

方法​

方法返回值描述
AcceptReviewChanges无接受审阅修订。
AddAddinField无使用请求中指定的数据创建新的加载项字段。
AddCommentstring | null向文档添加批注。
AddContentControlContentControl向文档添加空内容控件。
AddContentControlCheckBox无向文档添加空的内容控件复选框。
AddContentControlDatePicker无向文档添加空的内容控件日期选择器。
AddContentControlList无向文档添加空的内容控件列表。
AddContentControlPicture无向文档添加空的内容控件图片。
AddOleObject无在当前文档位置添加 OLE 对象。
AnnotateParagraph无向指定段落添加批注。
CanRedoboolean检查是否可以恢复用户上一次撤销的操作。
CanUndoboolean检查是否可以撤销用户的上一次操作。
ChangeComment无更改指定的批注。
ChangeOleObject无更改 OLE 对象数据中指定 InternalId 的 OLE 对象。
ChangeOleObjects无更改 OLE 对象数据中指定 InternalIds 的多个 OLE 对象。
CoAuthoringChatSendMessage无向协作聊天发送消息。
ConvertDocumentstring将文档转换为 Markdown 或 HTML 文本。
EditOleObject无编辑文档中的 OLE 对象。
EndAction无指定长时间操作的结束操作。
FocusEditor无将焦点返回到编辑器。
GetAllAddinFieldsAddinFieldData[]返回当前文档中的所有加载项字段。
GetAllCommentscomment[]返回文档中的所有批注。
GetAllContentControlsContentControl[]返回已添加到页面的所有内容控件的信息。
GetAllFormsContentControl[]返回已添加到文档的所有表单的信息。
GetAllOleObjectsOLEObjectData[]返回可由指定插件打开的对象的所有 OLE 对象数据。如果未定义 sPluginId，此方法将返回当前文档中包含的所有 OLE 对象。
GetCurrentAddinFieldAddinFieldData返回文档中的当前加载项字段。
GetCurrentBookmarkstring | null返回当前书签。
GetCurrentContentControlstring返回所选内容控件的标识符（即鼠标光标当前所在的内容控件）。
GetCurrentContentControlPrContentControlProperties返回当前内容控件的属性。
GetCurrentSentencestring返回当前句子。
GetCurrentWordstring返回当前单词。
GetDocumentLangstring返回文档语言。
GetFieldsstring[]以文本形式返回所有字段。
GetFileHTMLstring以 HTML 格式返回文件内容。
GetFileToDownloadstring以指定格式返回要下载的当前文件。
GetFontListFontInfo[]返回字体列表。
GetFormValuenull | string | boolean返回指定表单的值。
GetFormsByTagContentControl[]返回已添加到文档中具有指定标签的所有表单的信息。
GetImageDataFromSelectionImageData返回所选图形中第一个图形的图像数据。如果没有选择图形，该方法将返回一个白色矩形。
GetInstalledPluginsPluginData[]返回所有已安装的插件。
GetMacrosMacros返回文档宏。
GetSelectedContentstring以指定格式返回所选内容。
GetSelectedOleObjectsOLEProperties[]返回所选 OLE 对象的数组。
GetSelectedTextstring返回文档中的所选文本。
GetSelectionTypeSelectionType返回当前选择的类型。
GetVBAMacrosstring | null返回文档中的所有 VBA 宏。
GetVersionstring返回编辑器版本。
InputText无向文档中插入文本。
InsertAndReplaceContentControlsContentControlProperties[]插入包含数据的内容控件。数据由 Document 的 JS 代码指定，或通过共享文档的链接指定。
InsertOleObject无在当前文档位置插入 OLE 对象。
InstallPluginobject使用指定的插件配置安装插件。
IsEditingOFormModeboolean检查文档是否处于 OForm 编辑模式。
IsFillingFormModeboolean检查文档是否处于表单填写模式。
IsFillingOFormModeboolean检查文档是否处于 OForm 填写模式。
IsFormSignedboolean检查指定的表单是否已进行数字签名。
MouseMoveWindow无当鼠标按钮在插件 iframe 内移动时向插件发送事件。
MouseUpWindow无当鼠标按钮在插件 iframe 内释放时向插件发送事件。
MoveCursorToContentControl无将光标移动到指定的内容控件。
MoveCursorToEnd无将光标移动到当前编辑区域（文档正文、页眉/页脚、脚注或自选图形）的末尾。此方法类似于按 Ctrl + End 键盘快捷键。
MoveCursorToStart无将光标移动到当前编辑区域（文档正文、页眉/页脚、脚注或自选图形）的开头。此方法类似于按 Ctrl + Home 键盘快捷键。
MoveToComment无将光标移动到指定的批注。
MoveToNextReviewChange无浏览审阅修订。
OnDropEvent无实现外部拖放模拟。
OnEncryption无加密文档。
OpenFile无打开包含字段的文件。
PasteHtml无将 HTML 格式的文本粘贴到文档中。
PasteText无将文本粘贴到文档中。
PutImageDataToSelection无用参数中指定的图像替换第一个选定的图形。如果没有选择图形，该方法将在当前位置插入图像。
Redo无恢复用户上一次撤销的操作。
RejectReviewChanges无拒绝审阅修订。
RemoveAddinField无删除指定的加载项字段。
RemoveAnnotationRange无从文档中删除特定的批注范围。
RemoveComments无删除指定的批注。
RemoveContentControlContentControlParentPr删除当前选定的内容控件，同时保留其所有内容。将删除鼠标光标当前所在位置的内容控件。
RemoveContentControls无删除多个内容控件。
RemoveFieldWrapper无删除字段包装器，仅保留字段内容。
RemoveOleObject无通过内部 ID 从文档中删除 OLE 对象。
RemoveOleObjects无通过内部 ID 从文档中删除多个 OLE 对象。
RemovePluginobject删除具有指定 GUID 的插件。
RemoveSelectedContent无从文档中删除所选内容。
ReplaceCurrentSentence无用指定的字符串替换当前句子。
ReplaceCurrentWord无用指定的字符串替换当前单词。
ReplaceTextSmartboolean用字符串数组中的相应文本替换选定内容中的每个段落（或单元格中的文本）。
SearchAndReplace无查找并替换文本。
SearchNextboolean从当前位置开始查找并选择下一个匹配的文本。
SelectAddinField无选择指定的加载项字段。
SelectAnnotationRange无使用给定的批注选择文档中的文本。
SelectContentControl无选择指定的内容控件。
SelectOleObject无选择指定的 OLE 对象。
SetDisplayModeInReview无设置修订的显示模式。
SetEditingRestrictions无设置文档编辑限制。
SetFormValue无为指定的表单设置值。
SetMacros无为文档设置宏。
SetPluginsOptions无从外部源配置插件。可以为所有插件或特定插件设置参数。例如，此方法可用于向插件传递授权令牌。此方法只能与连接器类一起使用。
SetProperties无为文档设置属性。
ShowButton无显示或隐藏页眉中的按钮。
ShowError无显示错误/警告消息。
ShowInputHelper无显示输入助手。
StartAction无指定长时间操作的开始操作。
UnShowInputHelper无隐藏输入助手。
Undo无撤销用户的上一次操作。
UpdateAddinFields无使用指定的数据更新加载项字段。
UpdatePluginobject使用指定的插件配置更新插件。