Form API

The Form API lists the methods and events a plugin can use when working with a form in ONLYOFFICE Docs. To work with the form content directly, such as form fields, run Office API code in callCommand. See Form API.

Methods

The following table lists the available methods.

Method	Returns	Description
AddOleObject	None	Adds an OLE object to the current document position.
CoAuthoringChatSendMessage	None	Sends a message to the co-authoring chat.
ConvertDocument	string	Converts a document to Markdown or HTML text.
EditOleObject	None	Edits an OLE object in the document.
EndAction	None	Specifies the end action for long operations.
FocusEditor	None	Returns focus to the editor.
GetAllForms	ContentControl[]	Returns information about all the forms that have been added to the document.
GetDocumentLang	string	Returns the document language.
GetFileToDownload	string	Returns the current file to download in the specified format.
GetFontList	FontInfo[]	Returns the fonts list.
GetFormValue	null | string | boolean	Returns a value of the specified form.
GetFormsByTag	ContentControl[]	Returns information about all the forms that have been added to the document with specified tag.
GetImageDataFromSelection	ImageData	Returns the image data from the first of the selected drawings.
GetInstalledPlugins	PluginData[]	Returns all the installed plugins.
GetMacros	Macros	Returns the document macros.
GetSelectedContent	string	Returns the selected content in the specified format.
GetSelectedOleObjects	OLEProperties[]	Returns an array of the selected OLE objects.
GetSelectedText	string	Returns the selected text from the document.
GetSelectionType	SelectionType	Returns the type of the current selection.
GetVBAMacros	string | null	Returns all VBA macros from the document.
GetVersion	string	Returns the editor version.
InputText	None	Inserts text into the document.
InstallPlugin	object	Installs a plugin using the specified plugin config.
IsEditingOFormMode	boolean	Checks if the document is in the editing OForm mode.
IsFillingFormMode	boolean	Checks if the document is in the filling form mode.
IsFillingOFormMode	boolean	Checks if the document is in the filling OForm mode.
IsFormSigned	boolean	Checks whether the specified form has been digitally signed.
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.
OnEncryption	None	Encrypts the document.
PasteHtml	None	Pastes text in the HTML format into the document.
PasteText	None	Pastes text into the document.
PutImageDataToSelection	None	Replaces the first selected drawing with the image specified in the parameters.
RemovePlugin	object	Removes a plugin with the specified GUID.
ReplaceTextSmart	boolean	Replaces each paragraph (or text in cell) in the select with the corresponding text from an array of strings.
SetFormValue	None	Sets a value to the specified form.
SetMacros	None	Sets macros to the document.
SetPluginsOptions	None	Configures plugins from an external source.
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.

Events

The following table lists the available events.

Event	Description
onChangeRestrictions	The function called when the restrictions in the editor are changed.
onClick	The function called when the user clicks the element.
onDocumentContentReady	The function called when the document is completely loaded.
onEnableMouseEvent	The function called to turn the mouse or touchpad events on/off.
onExternalMouseUp	The function called when the mouse button is released outside the plugin iframe.
onSubmitForm	The function called when the user clicks the "Complete & Submit" button.
onTargetPositionChanged	The function called when the target position in the editor is changed.