DocSpace
JavaScript SDK
Plugins SDK
API Backend
For hosting providers
Docs
Docs API
Office API
Plugins and Macros
Document Builder
Desktop Editors
Workspace
API Backend
For hosting providers
TRY NEW VERSION
Get Started
Overview
Getting started with plugins
Plugin types
Plugin structure
Usage API
Config
Plugin variations
Plugin icons
index.html
Plugin object
Methods
attachContextMenuClickEvent
attachEvent
callCommand
callModule
createInputHelper
executeMethod
Common Api
ActivateWindow
AddContextMenuItem
AddOleObject
AddToolbarMenuItem
CloseWindow
CoAuthoringChatSendMessage
ConvertDocument
EditOleObject
EndAction
GetDocumentLang
GetFileToDownload
GetFontList
GetImageDataFromSelection
GetInstalledPlugins
GetMacros
GetSelectedOleObjects
GetSelectedText
GetSelectionType
GetVBAMacros
GetVersion
InputText
InstallDeveloperPlugin
InstallPlugin
MouseMoveWindow
MouseUpWindow
OnDropEvent
OnEncryption
PasteHtml
PasteText
PutImageDataToSelection
RemovePlugin
ReplaceTextSmart
ResizeWindow
SendToWindow
SetMacros
SetProperties
ShowButton
ShowInputHelper
ShowWindow
StartAction
UnShowInputHelper
UpdateContextMenuItem
UpdatePlugin
Text Document Api
AcceptReviewChanges
AddAddinField
AddComment
AddContentControl
AddContentControlCheckBox
AddContentControlDatePicker
AddContentControlList
AddContentControlPicture
ChangeComment
ChangeOleObject
ChangeOleObjects
GetAllAddinFields
GetAllComments
GetAllContentControls
GetAllOleObjects
GetCurrentContentControl
GetCurrentContentControlPr
GetCurrentSentence
GetCurrentWord
GetFields
GetFileHTML
InsertAndReplaceContentControls
InsertOleObject
MoveCursorToContentControl
MoveCursorToEnd
MoveCursorToStart
MoveToComment
MoveToNextReviewChange
OpenFile
RejectReviewChanges
RemoveComments
RemoveContentControl
RemoveContentControls
RemoveFieldWrapper
RemoveOleObject
RemoveOleObjects
RemoveSelectedContent
ReplaceCurrentSentence
ReplaceCurrentWord
SearchAndReplace
SearchNext
SelectContentControl
SelectOleObject
SetDisplayModeInReview
SetEditingRestrictions
UpdateAddinFields
Spreadsheet Api
AddComment
ChangeComment
GetAllComments
GetCustomFunctions
RemoveComments
SetCustomFunctions
Presentation Api
AddComment
ChangeComment
EndSlideShow
GetAllComments
GoToNextSlideInSlideShow
GoToPreviousSlideInSlideShow
GoToSlideInSlideShow
PauseSlideShow
RemoveComments
ResumeSlideShow
StartSlideShow
Form Api
GetAllForms
GetFormsByTag
GetFormValue
SetFormValue
getInputHelper
loadModule
resizeWindow
sendToPlugin
Events
button
init
inputHelper_onSelectItem
onAddComment
onBlurContentControl
onChangeCommentData
onChangeContentControl
onClick
onCommandCallback
onContextMenuClick
onContextMenuShow
onDocumentContentReady
onEnableMouseEvent
onExternalMouseUp
onExternalPluginMessage
onFocusContentControl
onInputHelperClear
onInputHelperInput
onMethodReturn
onRemoveComment
onTargetPositionChanged
onToolbarMenuClick
onTranslate
Asc.scope object
info object
InputHelper
createWindow
getItems
getScrollSizes
setItems
show
unShow
Simple types
Plugins
Developing plugins
Adding plugins
ONLYOFFICE Desktop Editors
ONLYOFFICE Docs on-premises
ONLYOFFICE Cloud
Plugin localization
Plugin styles
Publishing plugins
Plugin examples
Add comment in cell
Add custom fields
Autocomplete
Chess
Clippy
Context menu and events
Count words and characters
Extended comments
Get and paste html
Hello world
Highlight code
Invoices
Language tool
Load custom fields
Move cursor
OCR
Photo editor
Search and change text background color
Search and replace
Search and replace on start
Settings
Speech
Symbol table
Telegram
Templates
Thesaurus
Translator
Typograf
Work with content controls content
Work with content controls navigation
Work with content controls tags
YouTube
Zotero
Macros
Getting started with macros
Writing macros
Debugging
Converting VBA macros
Macro samples
Write data to worksheet cell
Change cell background color
Change cell font color
Make cell font bold
Merge cell range
Unmerge cell range
Set column width
Format range as a table
Add chart
Highlight duplicates
Next blank row
Insert text
Currency exchange rates
Import CSV/TXT data
Recalculate worksheet values
Unhide all rows and columns
Remove shapes from slides
Insert unique id
Complete address information
More information
Changelog
FAQ
Changelog
The list of changes for ONLYOFFICE Plugins and Macros API.
Version 8.1
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 to
window.Asc.plugin.executeMethod
.
Added the
AddToolbarMenuItem
method to
window.Asc.plugin.executeMethod
.
Added the
GetSelectedOleObjects
method to
window.Asc.plugin.executeMethod
.
Added the
GetAllComments
method to
window.Asc.plugin.executeMethod
for Spreadsheet Api.
Added the
GetCustomFunctions
method to
window.Asc.plugin.executeMethod
for Spreadsheet Api.
Added the
SetCustomFunctions
method to
window.Asc.plugin.executeMethod
for Spreadsheet Api.
Added the
GetAllComments
method to
window.Asc.plugin.executeMethod
for Presentation Api.
Added the
OLEProperties
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 to
window.Asc.plugin.executeMethod
.
Added the
EndSlideShow
method to
window.Asc.plugin.executeMethod
.
Added the
GoToNextSlideInSlideShow
method to
window.Asc.plugin.executeMethod
.
Added the
GoToPreviousSlideInSlideShow
method to
window.Asc.plugin.executeMethod
.
Added the
GoToSlideInSlideShow
method to
window.Asc.plugin.executeMethod
.
Added the
PauseSlideShow
method to
window.Asc.plugin.executeMethod
.
Added the
ResumeSlideShow
method to
window.Asc.plugin.executeMethod
.
Added the
StartSlideShow
method to
window.Asc.plugin.executeMethod
.
Version 7.5
Added the
align
parameter to the
ShowButton
method of
window.Asc.plugin.executeMethod
.
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 to
window.Asc.plugin.executeMethod
.
Added the
CloseWindow
method to
window.Asc.plugin.executeMethod
.
Added the
GetCurrentSentence
method to
window.Asc.plugin.executeMethod
.
Added the
GetCurrentWord
method to
window.Asc.plugin.executeMethod
.
Added the
GetDocumentLang
method to
window.Asc.plugin.executeMethod
.
Added the
InstallDeveloperPlugin
method to
window.Asc.plugin.executeMethod
.
Added the
MouseMoveWindow
method to
window.Asc.plugin.executeMethod
.
Added the
MouseUpWindow
method to
window.Asc.plugin.executeMethod
.
Added the
ReplaceCurrentSentence
method to
window.Asc.plugin.executeMethod
.
Added the
ReplaceCurrentWord
method to
window.Asc.plugin.executeMethod
.
Added the
ResizeWindow
method to
window.Asc.plugin.executeMethod
.
Added the
SendToWindow
method to
window.Asc.plugin.executeMethod
.
Added the
ShowWindow
method to
window.Asc.plugin.executeMethod
.
Added the
UpdateContextMenuItem
method to
window.Asc.plugin.executeMethod
.
Added the
backup
parameter to the
RemovePlugin
method of
window.Asc.plugin.executeMethod
.
Added the
NewLineSeparator
parameter to the
GetSelectedText
method of
window.Asc.plugin.executeMethod
.
Added the
replaceMode
parameter to the
ImageData
object.
Version 7.3
Added the
sign
type to the
initDataType
config parameter.
Added the
AddAddinField
method to
window.Asc.plugin.executeMethod
.
Added the
GetAllAddinFields
method to
window.Asc.plugin.executeMethod
.
Added the
GetVBAMacros
method to
window.Asc.plugin.executeMethod
.
Added the
OnDropEvent
method to
window.Asc.plugin.executeMethod
.
Added the
RemoveFieldWrapper
method to
window.Asc.plugin.executeMethod
.
Added the
SetEditingRestrictions
method to
window.Asc.plugin.executeMethod
.
Added the
UpdateAddinFields
method to
window.Asc.plugin.executeMethod
.
Added the
Spreadsheet Api
methods to
window.Asc.plugin.executeMethod
.
Added the
Presentation Api
methods to
window.Asc.plugin.executeMethod
.
Version 7.2
Added the
onAddComment
event.
Added the
onChangeCommentData
event.
Added the
onRemoveComment
event.
Added the
AcceptReviewChanges
method to
window.Asc.plugin.executeMethod
.
Added the
MoveToNextReviewChange
method to
window.Asc.plugin.executeMethod
.
Added the
RejectReviewChanges
method to
window.Asc.plugin.executeMethod
.
Changed the plugin
localization
scheme.
Added the
ONLYOFFICE Plugin Marketplace
.
Added the
ChangeOleObject
method to
window.Asc.plugin.executeMethod
.
Added the
GetAllForms
method to
window.Asc.plugin.executeMethod
.
Added the
GetFileToDownload
method to
window.Asc.plugin.executeMethod
.
Added the
GetFormsByTag
method to
window.Asc.plugin.executeMethod
.
Added the
GetFormValue
method to
window.Asc.plugin.executeMethod
.
Added the
GetImageDataFromSelection
method to
window.Asc.plugin.executeMethod
.
Added the
GetInstalledPlugins
method to
window.Asc.plugin.executeMethod
.
Added the
InstallPlugin
method to
window.Asc.plugin.executeMethod
.
Added the
PutImageDataToSelection
method to
window.Asc.plugin.executeMethod
.
Added the
RemovePlugin
method to
window.Asc.plugin.executeMethod
.
Added the
SetFormValue
method to
window.Asc.plugin.executeMethod
.
Added the
ShowButton
method to
window.Asc.plugin.executeMethod
.
Added the
UpdatePlugin
method to
window.Asc.plugin.executeMethod
.
Added the
onBlurContentControl
event.
Added the
onChangeContentControl
event.
Added the
onFocusContentControl
event.