PDF API

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

方法

下表列出了可用的方法。

方法	返回值	描述
CoAuthoringChatSendMessage	无	向协作聊天发送消息。
EndAction	无	指定长时间操作的结束操作。
FocusEditor	无	将焦点返回到编辑器。
GetAllComments	comment[]	返回文档中的所有批注。
GetCurrentPage	number	返回当前页面索引。
GetFileToDownload	string	以指定格式返回要下载的当前文件。
GetFontList	FontInfo[]	返回字体列表。
GetInstalledPlugins	PluginData[]	返回所有已安装的插件。
GetMacros	Macros	返回文档宏。
GetPageImage	canvas	返回页面图像。
GetSelectedText	string	返回文档中的所选文本。
GetVersion	string	返回编辑器版本。
GoToPage	boolean	移动到指定页面。
InstallPlugin	object	使用指定的插件配置安装插件。
MouseMoveWindow	无	当鼠标按钮在插件 iframe 内移动时向插件发送事件。
MouseUpWindow	无	当鼠标按钮在插件 iframe 内释放时向插件发送事件。
OnDropEvent	无	实现外部拖放模拟。
PasteHtml	无	将 HTML 格式的文本粘贴到文档中。
PasteText	无	将文本粘贴到文档中。
RemovePlugin	object	删除具有指定 GUID 的插件。
ReplacePageContent	boolean	使用指定的参数替换页面内容。
SetMacros	无	为文档设置宏。
SetPluginsOptions	无	从外部源配置插件。可以为所有插件或特定插件设置参数。
SetProperties	无	为文档设置属性。
ShowButton	无	显示或隐藏页眉中的按钮。
ShowError	无	显示错误/警告消息。
ShowInputHelper	无	显示输入助手。
StartAction	无	指定长时间操作的开始操作。
UnShowInputHelper	无	隐藏输入助手。
UpdatePlugin	object	使用指定的插件配置更新插件。

事件

下表列出了可用的事件。

事件	描述
onChangeRestrictions	当编辑器中的限制更改时调用的函数。
onClick	用户点击元素时调用的函数。
onDocumentContentReady	当文档完全加载时调用的函数。
onEnableMouseEvent	用于开启/关闭鼠标或触控板事件的函数。
onExternalMouseUp	当鼠标按钮在插件 iframe 外部释放时调用的函数。
onTargetPositionChanged	当编辑器中的目标位置发生更改时调用的函数。