Api

new Api()

Base class

Methods

Name Description
AddContextMenuItem

Adds an item to the context menu.

AddOleObject

Adds an OLE object to the current document position.

CloseWindow

Closes the plugin modal window.

CoAuthoringChatSendMessage

Sends a message to the co-authoring chat.

ConvertDocument

Converts a document to Markdown or HTML text.

EditOleObject

Edits an OLE object in the document.

EndAction

Specifies the end action for long operations.

GetDocumentLang

Returns the document language.

GetFileToDownload

Returns the current file to download in the specified format.

GetFontList

Returns the fonts list.

GetImageDataFromSelection

Returns the image data from the first of the selected drawings. If there are no drawings selected, the method returns a white rectangle.

GetInstalledPlugins

Returns all the installed plugins.

GetMacros

Returns the document macros.

GetSelectedText

Returns the selected text from the document.

GetSelectionType

Returns the type of the current selection.

GetVBAMacros

Returns all VBA macros from the document.

GetVersion

Returns the editor version.

InputText

Inserts text into the document.

InstallDeveloperPlugin

Installs a plugin by the URL to the plugin config.

InstallPlugin

Installs a plugin by the URL to the plugin config.

MouseMoveWindow

Sends an event to the plugin when the mouse button is moved inside the plugin iframe.

MouseUpWindow

Sends an event to the plugin when the mouse button is released inside the plugin iframe.

OnDropEvent

Implements the external drag&drop emulation.

OnEncryption

Encrypts the document.

PasteHtml

Pastes text in the HTML format into the document.

PasteText

Pastes text into the document.

PutImageDataToSelection

Replaces the first selected drawing with the image specified in the parameters. If there are no drawings selected, the method inserts the image at the current position.

RemovePlugin

Removes a plugin with the specified GUID.

ReplaceTextSmart

Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings.

ResizeWindow

Resizes the plugin modal window.

SendToWindow

Sends a message to the plugin modal window.

SetMacros

Sets macros to the document.

SetProperties

Sets the properties to the document.

ShowButton

Shows or hides buttons in the header.

ShowInputHelper

Shows the input helper.

ShowWindow

Shows the plugin modal window.

StartAction

Specifies the start action for long operations.

UnShowInputHelper

Unshows the input helper.

UpdateContextMenuItem

Updates an item in the context menu with the specified items.

UpdatePlugin

Updates a plugin by the URL to the plugin config.