Changelog

The list of changes for ONLYOFFICE Plugins and Macros API.

Version 10.0

• Added the global Editor object to the plugins API. Editor methods are now called as functions that return a Promise, for example, await Editor.GetSelectedText(), instead of through window.Asc.plugin.executeMethod. A callback passed as the last argument is still supported.
• Added the Editor.RunMacro method, which runs a function with the editor API, passes arguments to it, and returns its result as a Promise.
• Renamed the IsFillingFormMode method to IsFillingForm for Document API and Form API. The old name still works.
• Renamed the IsFillingOFormMode method to IsFillingPdfForm for Document API and Form API. The old name still works.
• Renamed the IsEditingOFormMode method to IsEditingPdfForm for Document API and Form API. The old name still works.
• Added the GetRestrictions method for Document API, Form API, Spreadsheet API, Presentation API, and PDF API.
• Added the SetButtonDisabled method for Document API, Spreadsheet API, and Presentation API.
• Added the GetOFormRole method for Document API and Form API.
• Added the MoveCursorToAnnotationRange method for Document API.
• Added the SetRangeHtml method for Document API.
• Added the InsertPresentationFromUrl method for Presentation API.
• Added the SetParagraphHtml method for Presentation API.
• Added the SetParagraphRangeHtml method for Presentation API.
• Added the AnnotateParagraph method for Presentation API.
• Added the SelectAnnotationRange method for Presentation API.
• Added the RemoveAnnotationRange method for Presentation API.
• Added the onFloatActionButtonClick event for Document API, Form API, Spreadsheet API, Presentation API, and PDF API.
• Added the onSelectionEnd event for PDF API.
• Added the onSelectionCancel event for PDF API.
• Added the EditorRestrictions type to the simple type definitions for Document API, Form API, Spreadsheet API, Presentation API, and PDF API.
• Added the CommentData type to the simple type definitions for PDF API.
• Added the comment type to the simple type definitions for PDF API.
• Added the Event_pt type to the simple type definitions for PDF API.

Version 9.4

• Added the MoveCursorToField method for Document API.
• Added the MoveCursorOutsideField method for Document API.
• Added the lockScroll and keepSelection parameters to the StartAction method.
• Added the scrollToTarget and cancel parameters to the EndAction method.

Version 9.3

• Added the SelectAddinField method for Document API.
• Added the RemoveAddinField method for Document API.
• Added the GetCurrentAddinField method for Document API.
• Added the IsFormSigned method for Document API.
• Added the CoAuthoringChatSendMessage method for PDF API.
• Added the EndAction method for PDF API.
• Added the FocusEditor method for PDF API.
• Added the GetAllComments method for PDF API.
• Added the GetCurrentPage method for PDF API.
• Added the GetFileToDownload method for PDF API.
• Added the GetFontList method for PDF API.
• Added the GetInstalledPlugins method for PDF API.
• Added the GetMacros method for PDF API.
• Added the GetPageImage method for PDF API.
• Added the GetSelectedText method for PDF API.
• Added the GetVersion method for PDF API.
• Added the InstallPlugin method for PDF API.
• Added the MouseMoveWindow method for PDF API.
• Added the MouseUpWindow method for PDF API.
• Added the OnDropEvent method for PDF API.
• Added the PasteHtml method for PDF API.
• Added the PasteText method for PDF API.
• Added the RemovePlugin method for PDF API.
• Added the ReplacePageContent method for PDF API.
• Added the SetMacros method for PDF API.
• Added the SetPluginsOptions method for PDF API.
• Added the SetProperties method for PDF API.
• Added the ShowButton method for PDF API.
• Added the ShowError method for PDF API.
• Added the ShowInputHelper method for PDF API.
• Added the StartAction method for PDF API.
• Added the UnShowInputHelper method for PDF API.
• Added the UpdatePlugin method for PDF API.

Version 9.2

• Added the AnnotateParagraph method for Document API.
• Added the RemoveAnnotationRange method for Document API.
• Added the SelectAnnotationRange method for Document API.
• Added the onBlurAnnotation event for Document API.
• Added the onClickAnnotation event for Document API.
• Added the onFocusAnnotation event for Document API.
• Added the onParagraphText event for Document API.
• Updated Adding plugins through the plugin manager for all users instruction according Help center info.

Version 9.1

• Added the RemoveOleObject method for Spreadsheet API.
• Added the RemoveOleObject method for Presentation API.

Version 9.0

• Added the ability to access cell address information inside custom functions.
• Added the ability to add asynchronous custom functions to the spreadsheets using the Macros plugin.
• Added the ability to automatically convert VBA code into ONLYOFFICE macros using AI plugin.
• Added the ability to automatically generate ONLYOFFICE macros using AI plugin.
• Added the ability to add custom buttons to content controls using a plugin.
• Added the GetCurrentBookmark method for Document API.
• Added the GoToSlide method for Presentation API.
• Added the ContentControlListElement enumeration.

Version 8.3

• Added the GetSelectedContent method.
• Added the ShowError method.
• Added the Shd and Border properties to the ContentControlProperties object.
• Added the isActivated parameter to the panel settings.

Version 8.2

• Added the onSubmitForm event.
• Added the CanRedo method for Document API.
• Added the CanUndo method for Document API.
• Added the Redo method for Document API.
• Added the Undo method for Document API.

Version 8.1

• Added the ability to add custom functions to the spreadsheets using the Macros plugin.
• Added the ability to add the plugin toolbar menu items.
• Added the ability to create multiple left panels for plugins.
• Added the information about the current position of the context menu plugin event.
• Added the onToolbarMenuClick event.
• Added the ActivateWindow method.
• Added the AddToolbarMenuItem method.
• Added the GetSelectedOleObjects method.
• Added the SetPluginsOptions method.
• Added the GetAllComments method for Spreadsheet API.
• Added the GetCustomFunctions method for Spreadsheet API.
• Added the SetCustomFunctions method for Spreadsheet API.
• Added the GetAllComments method for Presentation API.
• Added the OLEProperties type to the simple type definitions.
• Added the PluginOptions type to the simple type definitions.
• Added the ToolbarMenuItem type to the simple type definitions.
• Added the ToolbarMenuMainItem type to the simple type definitions.
• Added the ToolbarMenuTab type to the simple type definitions.
• Added the ToolbarMenuItemType type to the simple type definitions.
• Added the icons and data parameters to the ContextMenuItem object.
• Added the menu config parameter.

Version 8.0

• Added the SearchNext method.
• Added the EndSlideShow method.
• Added the GoToNextSlideInSlideShow method.
• Added the GoToPreviousSlideInSlideShow method.
• Added the GoToSlideInSlideShow method.
• Added the PauseSlideShow method.
• Added the ResumeSlideShow method.
• Added the StartSlideShow method.

Version 7.5

• Added the align parameter to the ShowButton method.

Version 7.4

• Added the ability to download ready-to-use plugins from ONLYOFFICE Plugin Marketplace in ONLYOFFICE Desktop Editors.
• Added the sendToPlugin method to the Plugin object.
• Added the onContextMenuClick event.
• Added the onContextMenuShow event.
• Added the AddContextMenuItem method.
• Added the CloseWindow method.
• Added the GetCurrentSentence method.
• Added the GetCurrentWord method.
• Added the GetDocumentLang method.
• Added the MouseMoveWindow method.
• Added the MouseUpWindow method.
• Added the ReplaceCurrentSentence method.
• Added the ReplaceCurrentWord method.
• Added the ResizeWindow method.
• Added the SendToWindow method.
• Added the ShowWindow method.
• Added the UpdateContextMenuItem method.
• Added the backup parameter to the RemovePlugin method.
• Added the NewLineSeparator parameter to the GetSelectedText method.
• Added the replaceMode parameter to the ImageData object.

Version 7.3

• Added the sign type to the initDataType config parameter.
• Added the AddAddinField method.
• Added the GetAllAddinFields method.
• Added the GetVBAMacros method.
• Added the OnDropEvent method.
• Added the RemoveFieldWrapper method.
• Added the SetEditingRestrictions method.
• Added the UpdateAddinFields method.
• Added the editor methods for Spreadsheet API.
• Added the editor methods for Presentation API.

Version 7.2

• Added the onAddComment event.
• Added the onChangeCommentData event.
• Added the onRemoveComment event.
• Added the AcceptReviewChanges method.
• Added the MoveToNextReviewChange method.
• Added the RejectReviewChanges method.
• Changed the plugin localization scheme.
• Added the ONLYOFFICE Plugin Marketplace.
• Added the ChangeOleObject method.
• Added the GetAllForms method.
• Added the GetFileToDownload method.
• Added the GetFormsByTag method.
• Added the GetFormValue method.
• Added the GetImageDataFromSelection method.
• Added the GetInstalledPlugins method.
• Added the InstallPlugin method.
• Added the PutImageDataToSelection method.
• Added the RemovePlugin method.
• Added the SetFormValue method.
• Added the ShowButton method.
• Added the UpdatePlugin method.
• Added the onBlurContentControl event.
• Added the onChangeContentControl event.
• Added the onFocusContentControl event.