Api
Represents the Api class.
Methods
| Method | Returns | Description |
|---|---|---|
| CoAuthoringChatSendMessage | None | Sends a message to the co-authoring chat. |
| EndAction | None | Specifies the end action for long operations. |
| FocusEditor | None | Returns focus to the editor. |
| GetAllComments | comment[] | Returns all the comments from the document. |
| GetCurrentPage | number | Returns the current page index. |
| GetFileToDownload | string | Returns the current file to download in the specified format. |
| GetFontList | FontInfo[] | Returns the fonts list. |
| GetInstalledPlugins | PluginData[] | Returns all the installed plugins. |
| GetMacros | Macros | Returns the document macros. |
| GetPageImage | canvas | Returns the page image. |
| GetSelectedText | string | Returns the selected text from the document. |
| GetVersion | string | Returns the editor version. |
| InstallPlugin | object | Installs a plugin using the specified plugin config. |
| MouseMoveWindow | None | Sends an event to the plugin when the mouse button is moved inside the plugin iframe. |
| MouseUpWindow | None | Sends an event to the plugin when the mouse button is released inside the plugin iframe. |
| OnDropEvent | None | Implements the external drag&drop emulation. |
| PasteHtml | None | Pastes text in the HTML format into the document. |
| PasteText | None | Pastes text into the document. |
| RemovePlugin | object | Removes a plugin with the specified GUID. |
| ReplacePageContent | boolean | Replaces the page content with the specified parameters. |
| SetMacros | None | Sets macros to the document. |
| SetPluginsOptions | None | Configures plugins from an external source. The settings can be set for all plugins or for a specific plugin. For example, this method can be used to pass an authorization token to the plugin. This method can be used only with the connector class. |
| SetProperties | None | Sets the properties to the document. |
| ShowButton | None | Shows or hides buttons in the header. |
| ShowError | None | Shows an error/warning message. |
| ShowInputHelper | None | Shows the input helper. |
| StartAction | None | Specifies the start action for long operations. |
| UnShowInputHelper | None | Unshows the input helper. |
| UpdatePlugin | object | Updates a plugin using the specified plugin config. |