Document API

Document API 包含 ONLYOFFICE 文档编辑器中 可供插件使用的方法和事件。

方法

下表列出了可用的方法。

方法	返回值	描述
AcceptReviewChanges	无	接受审阅修订。
AddAddinField	AddinFieldData	使用请求中指定的数据创建新的加载项字段。
AddComment	string | null	向文档添加批注。
AddContentControl	ContentControl	向文档添加空内容控件。
AddContentControlCheckBox	无	向文档添加空的内容控件复选框。
AddContentControlDatePicker	无	向文档添加空的内容控件日期选择器。
AddContentControlList	无	向文档添加空的内容控件列表。
AddContentControlPicture	无	向文档添加空的内容控件图片。
AddOleObject	无	在当前文档位置添加 OLE 对象。
AnnotateParagraph	无	向指定的段落添加注解。
CanRedo	boolean	检查是否可以恢复用户上一次撤销的操作。
CanUndo	boolean	检查是否可以撤销用户的上一次操作。
ChangeComment	无	更改指定的批注。
ChangeOleObject	无	更改 OLE 对象数据中指定 InternalId 的 OLE 对象。
ChangeOleObjects	无	更改 OLE 对象数据中指定 InternalIds 的多个 OLE 对象。
CoAuthoringChatSendMessage	无	向协作聊天发送消息。
ConvertDocument	string	将文档转换为 Markdown 或 HTML 文本。
EditOleObject	无	编辑文档中的 OLE 对象。
EndAction	无	指定长时间操作的结束操作。
FocusEditor	无	将焦点返回到编辑器。
GetAllAddinFields	AddinFieldData[]	返回当前文档中的所有加载项字段。
GetAllComments	comment[]	返回文档中的所有批注。
GetAllContentControls	ContentControl[]	返回已添加到页面的所有内容控件的信息。
GetAllForms	ContentControl[]	返回已添加到文档的所有表单的信息。
GetAllOleObjects	OLEObjectData[]	返回可由指定插件打开的对象的所有 OLE 对象数据。
GetCurrentAddinField	AddinFieldData	返回文档中的当前加载项字段。
GetCurrentBookmark	string | null	返回当前书签。
GetCurrentContentControl	string	返回所选内容控件的标识符（即鼠标光标当前所在的内容控件）。
GetCurrentContentControlPr	ContentControlProperties	返回当前内容控件的属性。
GetCurrentSentence	string	返回当前句子。
GetCurrentWord	string	返回当前单词。
GetDocumentLang	string	返回文档语言。
GetFields	string[]	以文本形式返回所有字段。
GetFileHTML	string	以 HTML 格式返回文件内容。
GetFileToDownload	string	以指定格式返回要下载的当前文件。
GetFontList	FontInfo[]	返回字体列表。
GetFormValue	null | string | boolean	返回指定表单的值。
GetFormsByTag	ContentControl[]	返回已添加到文档中具有指定标签的所有表单的信息。
GetImageDataFromSelection	ImageData	返回所选图形中第一个图形的图像数据。如果没有选择图形，该方法将返回一个白色矩形。
GetInstalledPlugins	PluginData[]	返回所有已安装的插件。
GetMacros	Macros	返回文档宏。
GetSelectedContent	string	以指定格式返回所选内容。
GetSelectedOleObjects	OLEProperties[]	返回所选 OLE 对象的数组。
GetSelectedText	string	返回文档中的所选文本。
GetSelectionType	SelectionType	返回当前选择的类型。
GetVBAMacros	string | null	返回文档中的所有 VBA 宏。
GetVersion	string	返回编辑器版本。
InputText	无	向文档中插入文本。
InsertAndReplaceContentControls	ContentControlProperties[]	插入包含数据的内容控件。数据由 Document 的 JS 代码指定，或通过共享文档的链接指定。
InsertOleObject	无	在当前文档位置插入 OLE 对象。
InstallPlugin	object	使用指定的插件配置安装插件。
IsEditingOFormMode	boolean	检查文档是否处于 OForm 编辑模式。
IsFillingFormMode	boolean	检查文档是否处于表单填写模式。
IsFillingOFormMode	boolean	检查文档是否处于 OForm 填写模式。
IsFormSigned	boolean	检查指定的表单是否已进行数字签名。
MouseMoveWindow	无	当鼠标按钮在插件 iframe 内移动时向插件发送事件。
MouseUpWindow	无	当鼠标按钮在插件 iframe 内释放时向插件发送事件。
MoveCursorOutsideField	无	将光标移动到字段外部，定位在字段之前或之后。
MoveCursorToContentControl	无	将光标移动到指定的内容控件。
MoveCursorToEnd	无	将光标移动到当前编辑区域（文档正文、页眉/页脚、脚注或自选图形）的末尾。
MoveCursorToField	无	将光标移动到字段的开头或末尾。
MoveCursorToStart	无	将光标移动到当前编辑区域（文档正文、页眉/页脚、脚注或自选图形）的开头。
MoveToComment	无	将光标移动到指定的批注。
MoveToNextReviewChange	无	浏览审阅修订。
OnDropEvent	无	实现外部拖放模拟。
OnEncryption	无	加密文档。
OpenFile	无	打开包含字段的文件。
PasteHtml	无	将 HTML 格式的文本粘贴到文档中。
PasteText	无	将文本粘贴到文档中。
PutImageDataToSelection	无	用参数中指定的图像替换第一个选定的图形。
Redo	无	恢复用户上一次撤销的操作。
RejectReviewChanges	无	拒绝审阅修订。
RemoveAddinField	无	删除指定的加载项字段。
RemoveAnnotationRange	无	从文档中移除特定的注解范围。
RemoveComments	无	删除指定的批注。
RemoveContentControl	ContentControlParentPr	删除当前选定的内容控件，同时保留其所有内容。将删除鼠标光标当前所在位置的内容控件。
RemoveContentControls	无	删除多个内容控件。
RemoveFieldWrapper	无	删除字段包装器，仅保留字段内容。
RemoveOleObject	无	通过内部 ID 从文档中删除 OLE 对象。
RemoveOleObjects	无	通过内部 ID 从文档中删除多个 OLE 对象。
RemovePlugin	object	删除具有指定 GUID 的插件。
RemoveSelectedContent	无	从文档中删除所选内容。
ReplaceCurrentSentence	无	用指定的字符串替换当前句子。
ReplaceCurrentWord	无	用指定的字符串替换当前单词。
ReplaceTextSmart	boolean	用字符串数组中的相应文本替换选定内容中的每个段落（或单元格中的文本）。
SearchAndReplace	无	查找并替换文本。
SearchNext	boolean	从当前位置开始查找并选择下一个匹配的文本。
SelectAddinField	无	选择指定的加载项字段。
SelectAnnotationRange	无	使用给定的注解在文档中选择文本。
SelectContentControl	无	选择指定的内容控件。
SelectOleObject	无	选择指定的 OLE 对象。
SetDisplayModeInReview	无	设置修订的显示模式。
SetEditingRestrictions	无	设置文档编辑限制。
SetFormValue	无	为指定的表单设置值。
SetMacros	无	为文档设置宏。
SetParagraphHtml	无	用从给定 HTML 字符串解析的内容替换指定段落的所有内容。
SetPluginsOptions	无	从外部源配置插件。可以为所有插件或特定插件设置参数。
SetProperties	无	为文档设置属性。
ShowButton	无	显示或隐藏页眉中的按钮。
ShowError	无	显示错误/警告消息。
ShowInputHelper	无	显示输入助手。
StartAction	无	指定长时间操作的开始操作。
UnShowInputHelper	无	隐藏输入助手。
Undo	无	撤销用户的上一次操作。
UpdateAddinFields	无	使用指定的数据更新加载项字段。
UpdatePlugin	object	使用指定的插件配置更新插件。

事件

下表列出了可用的事件。

事件	描述
onAddComment	使用 AddComment 方法向文档添加批注时调用的函数。
onBlurAnnotation	当批注失去焦点时调用的函数。
onBlurContentControl	用于显示哪个内容控件已失去焦点的函数。
onChangeCommentData	使用 ChangeComment 方法更改指定批注时调用的函数。
onChangeContentControl	用于显示哪个内容控件已更改的函数。
onChangeCurrentPage	当前页面发生更改时调用的函数。
onChangeRestrictions	当编辑器中的限制更改时调用的函数。
onClick	用户点击元素时调用的函数。
onClickAnnotation	用户点击批注时调用的函数。
onDocumentContentReady	当文档完全加载时调用的函数。
onEnableMouseEvent	用于开启/关闭鼠标或触控板事件的函数。
onExternalMouseUp	当鼠标按钮在插件 iframe 外部释放时调用的函数。
onFocusAnnotation	当批注获得焦点时调用的函数。
onFocusContentControl	用于显示哪个内容控件已获得焦点的函数。
onHideContentControlTrack	当内容控件在文档中失去焦点时调用的函数。
onInsertOleObjects	当一个或多个 OLE 对象插入文档时调用的函数。
onParagraphText	当文档中的段落文本更新时调用的函数。
onRemoveComment	使用 RemoveComments 方法删除指定批注时调用的函数。
onShowContentControlTrack	当内容控件获得焦点并显示其轨道时调用的函数。
onSubmitForm	用户点击"完成并提交"按钮时调用的函数。
onTargetPositionChanged	当编辑器中的目标位置发生更改时调用的函数。