Events

The events section allows to change all the functions pertaining to the events.

Please note that to use events in your plugin code, you must subscribe to them first by specifying each event in the events parameter of the plugin config.

You can also subscibe to any event using the attachEvent method.

Look at the example of using plugin events here.

Events and their description:

Name Description
button

The function called when any of the plugin buttons is clicked. It defines the buttons used with the plugin and the plugin behavior when they are clicked.

init

The function called when the plugin is launched. It defines the data sent to the plugin describing what actions are to be performed and how they must be performed.

inputHelper_onSelectItem

The function called when the user is trying to select an item from the input helper.

onAddComment

The function called when a comment is added to the document with the AddComment method.

onBlurContentControl

The function called to show which content control has been blurred.

onChangeCommentData

The function called when the specified comment is changed with the ChangeComment method.

onChangeContentControl

The function called to show which content control has been changed.

onClick

The function called when the user clicks on the element.

onCommandCallback

The function called to return the result of the previously executed command. It can be used to return data after executing the callCommand method.

onContextMenuClick

The function called when the context menu item has been clicked.

onContextMenuShow

The function called when the context menu has been shown.

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.

onExternalPluginMessage

The function called to show the editor integrator message.

onFocusContentControl

The function called to show which content control has been focused.

onInputHelperClear

The function called when the user is trying to clear the text and the input helper disappears.

onInputHelperInput

The function called when the user is trying to input the text and the input helper appears.

onMethodReturn

The function called to return the result of the previously executed method. It can be used to return data after executing the executeMethod method.

onRemoveComment

The function called when the specified comment is removed with the RemoveComments method.

onTargetPositionChanged

The function called when the target position in the editor is changed.

onTranslate

The function called right after the plugin startup or later in case the plugin language is changed.