Get Started
Plugins
Macros
More information

Plugin

new Plugin()

Methods

Name Description
callCommand

Defines the method used to send the data back to the editor. It replaces the executeCommand method when working with texts in order to simplify the syntax of the script that is necessary to pass to the editors using ONLYOFFICE Document Builder API. It allows the plugin to send structured data that can be inserted to the resulting document file (formatted paragraphs, tables, text parts, and separate words, etc.).

The callback is the result that the command returns. It is an optional parameter. In case it is missing, the window.Asc.plugin.onCommandCallback function will be used to return the result of the command execution. ONLYOFFICE Document Builder commands can be only used to create content and insert it to the document editor (using the Api.GetDocument().InsertContent(...)). This limitation exists due to the co-editing feature in the online editors. If it is necessary to create a plugin for desktop editors to work with local files, no such limitation is applied.

This method is executed in its own context isolated from other JavaScript data. If some parameters or other data need to be passed to this method, use Asc.scope object.

callModule

Defines the method used to execute a remotely located script following a link.

createInputHelper

Defines the method used to create an input helper - a window that appears and disappears when you type text. Its location is tied to the cursor.

executeCommand

Defines the method used to send the data back to the editor. This method is deprecated, please use the callCommand method which runs the code from the data string parameter.

Now this method is mainly used to work with the OLE objects or close the plugin without any other commands. It is also retained for using with text so that the previous versions of the plugin remain compatible.

The callback is the result that the command returns. It is an optional parameter. In case it is missing, the window.Asc.plugin.onCommandCallback function will be used to return the result of the command execution.

The second parameter is the JavaScript code for working with ONLYOFFICE Document Builder API that allows the plugin to send structured data inserted to the resulting document file (formatted paragraphs, tables, text parts, and separate words, etc.). ONLYOFFICE Document Builder commands can be only used to create content and insert it to the document editor (using the Api.GetDocument().InsertContent(...)). This limitation exists due to the co-editing feature in the online editors. If it is necessary to create a plugin for the desktop editors to work with local files, no such limitation is applied.

When creating/editing OLE objects, two extensions are used to work with them:

  • Api.asc_addOleObject (window.Asc.plugin.info) - used to create an OLE object in the document;
  • Api.asc_editOleObject (window.Asc.plugin.info) - used to edit the created OLE object.

When creating/editing the objects, their properties can be passed to the window.Asc.plugin.info object that defines how the object should look.

executeMethod

Defines the method used to execute certain editor methods using the plugin.

The callback is the result that the method returns. It is an optional parameter. In case it is missing, the window.Asc.plugin.onMethodReturn function will be used to return the result of the method execution.

getInputHelper

Defines the method used to get the InputHelper object.

loadModule

Defines the method used to load a remotely located text resource.

resizeWindow

Defines the method used to change the window size updating the minimum/maximum sizes. This method is used for visual modal plugins only.