Плагин получает от редактора два вида вызовов:
- события редактора — что-то произошло в документе: пользователь щёлкнул мышью, добавил комментарий, открыл контекстное меню. На большинство из них нужно подписаться в config.json ↗;
- обработчики плагина — запуск, нажатие кнопки, ответ на метод. Они работают без подписки.
Как подписаться на событие
1. Укажите имя события в массиве events вариации в config.json. Без этого редактор не отправляет событие плагину:
"variations": [{
"description": "My plugin",
"url": "index.html",
"EditorsSupport": ["word", "cell", "slide"],
"events": ["onClick", "onTargetPositionChanged"]
}]2. Назначьте обработчик в коде плагина одним из двух способов: функцией window.Asc.plugin.event_<имя события> или методом window.Asc.plugin.attachEvent:
// способ 1
window.Asc.plugin.event_onClick = function (isSelectionUse) {
console.log("Щелчок в документе, есть выделение: " + isSelectionUse);
};
// способ 2
window.Asc.plugin.attachEvent("onTargetPositionChanged", function () {
console.log("Курсор переместился");
});Если для одного события заданы оба способа, срабатывает только event_. На одно событие attachEvent хранит один обработчик: повторный вызов заменяет прежний. Отключить обработчик, назначенный через attachEvent, можно методом window.Asc.plugin.detachEvent("<имя события>").
attachEvent не заменяет поле events: он только запоминает обработчик внутри плагина. После правки поля events откройте новый документ: редактор читает config.json при открытии документа.
События редактора
| Событие | Редакторы | Когда приходит | Данные |
|---|---|---|---|
onDocumentContentReady | все | Документ полностью загружен. Плагин, запущенный позже, получает событие сразу после запуска. | Нет |
onClick | все | Документы: пользователь отпустил кнопку мыши в документе или нажал Ctrl+Пробел при вводе текста. Таблицы и презентации: только Ctrl+Пробел при вводе текста, щелчок мышью событие не вызывает. | Щелчок мышью в документах: true, если есть выделение, иначе false. Ctrl+Пробел — без данных. |
onTargetPositionChanged | все | Изменилось положение курсора ввода. | Нет |
onInputHelperInput | все | Пользователь вводит текст, на каждый символ. | Объект { text } — набираемое слово целиком: "a", "ab", "abc". |
onInputHelperClear | все | Набор слова прерван: щелчок в документе, перемещение курсора стрелками, выход из ячейки. | Нет |
onInsertOleObjects | все | В документ вставлен OLE-объект. | Массив объектов, по одному на каждый вставленный OLE-объект: Data, ApplicationId (guid плагина), ImageData, Width, Height, WidthPix и другие поля. |
onContextMenuShow | все | Пользователь открывает контекстное меню. В ответ плагин может добавить свои пункты методом AddContextMenuItem. | Объект { type }, например { "type": "Target" } для меню в тексте. |
onFocusContentControl | документы | Элемент управления содержимым получил фокус. | Объект { Tag, InternalId } — тег и внутренний идентификатор элемента управления. |
onBlurContentControl | документы | Элемент управления содержимым потерял фокус. | То же |
onChangeContentControl | документы | Изменилось содержимое элемента управления. | То же |
onAddComment | документы | Добавлен комментарий. | Объект { Id, Data }. Data: Text, Time, UserName, QuoteText (текст, к которому привязан комментарий), Solved, UserData, Replies. |
onChangeCommentData | документы | Изменён комментарий. | Объект { Id, Data }. |
onRemoveComment | документы | Удалён комментарий. | Объект { Id }. |
События без подписки
Эти два события редактор отправляет только плагину, которому они адресованы, поле events для них не нужно:
| Событие | Редакторы | Когда приходит | Данные |
|---|---|---|---|
onContextMenuClick | все | Пользователь выбрал пункт контекстного меню, добавленный плагином. | Идентификатор пункта. Удобнее обрабатывать через window.Asc.plugin.attachContextMenuClickEvent(id, функция).Обработчик щелчка задавайте только через |
onKeyDown | все | Пока плагин показывает помощник ввода, пользователь нажимает Tab, Enter, Esc, стрелки вверх и вниз, PgUp, PgDn, Home или End. | Объект { keyCode }. |
Обработчики плагина
Обработчики назначаются как функции window.Asc.plugin.<имя> и работают без поля events.
| Обработчик | Когда вызывается |
|---|---|
init(data) | Плагин запущен. data зависит от initDataType в config.json ↗. |
button(id, windowId) | Нажата кнопка окна плагина; id — номер кнопки в массиве buttons, -1 — окно закрыто. Если обработчик не задан, при -1 плагин закрывается. |
onMethodReturn(result) | Пришёл результат executeMethod ↗, вызванного без функции обратного вызова. |
onCommandCallback(result) | Пришёл результат callCommand ↗, вызванного без функции обратного вызова. |
onTranslate() | Загружены переводы плагина. |
onThemeChanged(theme) | При запуске и при смене темы интерфейса. Если обработчик задан, стандартные стили темы не применяются — вызовите window.Asc.plugin.onThemeChangedBase(theme). |
onExternalMouseUp() | Кнопка мыши отпущена за пределами окна плагина. |
onEnableMouseEvent(isEnabled) | Редактор включает или отключает передачу событий мыши плагину. |
onExternalPluginMessage(data) | Пришло сообщение от внешнего кода; data содержит поле type. |
inputHelper_onSelectItem(item) | Пользователь выбрал элемент в помощнике ввода; item — объект { id, text }. |
Пример
Плагин считает комментарии в документе.
В файле config.json укажите события:
"events": ["onAddComment", "onRemoveComment"]
В JavaScript-коде плагина добавьте обработчики:
var count = 0;
window.Asc.plugin.event_onAddComment = function (data) {
count++;
console.log("Добавлен комментарий " + data.Id + ", всего: " + count);
};
window.Asc.plugin.event_onRemoveComment = function (data) {
count--;
console.log("Удалён комментарий " + data.Id + ", всего: " + count);
};












