Задача
Плагин добавляет в контекстное меню пункт «Вставить дату». По щелчку на него в позицию курсора вставляется сегодняшняя дата в формате ДД.ММ.ГГГГ.
Это фоновый плагин: у него нет окна и панели ("isVisual": false). После запуска с вкладки Плагины он работает, пока открыт документ, или пока по его кнопке не щелкнут еще раз.
Редакторы: Документы, Таблицы, Презентации.
Методы и события
| Что | Зачем в примере |
|---|---|
| Событие onContextMenuShow | Редактор открывает контекстное меню. В данных события поле type говорит, что под курсором: Target (курсор в тексте), Selection (выделение), Image, Shape, OleObject. |
| Метод AddContextMenuItem | Ответ плагина на onContextMenuShow: GUID плагина и список пунктов { id, text }. |
| attachContextMenuClickEvent(id, функция) | Связывает пункт меню с обработчиком щелчка. |
| Метод PasteText ↗ | Вставляет дату в позицию курсора. |
В config.json в массиве events достаточно onContextMenuShow: событие щелчка по пункту приходит плагину без подписки. Подробнее — в статье События плагинов ↗.
Важно. Щелчок по пункту нужно обрабатывать через attachContextMenuClickEvent, а не через attachEvent("onContextMenuClick", ...). В файле plugins.js уже есть свой обработчик event_onContextMenuClick, и он вызывается вместо attachEvent. В итоге функция из attachEvent не сработает никогда.
Код плагина
Плагин состоит из трех файлов и папки с иконками. GUID в config.json у каждого плагина свой: для своего плагина сгенерируйте новый.
config.json
{
"name": "Insert date",
"nameLocale": { "ru": "Дата в контекстном меню" },
"guid": "asc.{7C086609-7EAB-40D3-B1E6-11D81C4BBB7F}",
"version": "1.0.0",
"variations": [
{
"description": "Adds the Insert date item to the context menu",
"descriptionLocale": { "ru": "Добавляет в контекстное меню пункт «Вставить дату»" },
"url": "index.html",
"icons": [ "resources/icon.png", "resources/icon@2x.png" ],
"isViewer": false,
"EditorsSupport": [ "word", "cell", "slide" ],
"isVisual": false,
"isModal": false,
"isInsideMode": false,
"initDataType": "none",
"initData": "",
"buttons": [],
"events": [ "onContextMenuShow" ]
}
]
}index.html
У фонового плагина страница пустая: она нужна только чтобы подключить скрипты.
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Insert date</title>
<script type="text/javascript" src="../v1/plugins.js"></script>
<script type="text/javascript" src="code.js"></script>
</head>
<body></body>
</html>code.js
// Пример «Пункт в контекстном меню». Автор: Александр Поляков
(function (window) {
var ITEM_ID = "insertDate";
// Фоновый плагин: окна нет, init только запускает плагин
window.Asc.plugin.init = function () {};
// 1. Редактор открывает контекстное меню и спрашивает плагин, что добавить
window.Asc.plugin.attachEvent("onContextMenuShow", function (options) {
var items = [];
// Пункт нужен только для текста, а не для картинки или фигуры
if (options.type === "Target" || options.type === "Selection") {
items.push({ id: ITEM_ID, text: "Вставить дату" });
}
// Отвечаем всегда, даже пустым списком: редактор ждет ответа
window.Asc.plugin.executeMethod("AddContextMenuItem", [{
guid: window.Asc.plugin.guid,
items: items
}]);
});
// 2. Пользователь выбрал пункт меню
window.Asc.plugin.attachContextMenuClickEvent(ITEM_ID, function () {
var today = new Date().toLocaleDateString("ru-RU");
window.Asc.plugin.executeMethod("PasteText", [today]);
});
window.Asc.plugin.button = function () {
this.executeCommand("close", "");
};
})(window);Редактор собирает ответы всех запущенных плагинов, подписанных на onContextMenuShow. Поэтому плагин вызывает AddContextMenuItem и тогда, когда добавлять нечего, — с пустым массивом items.
Как установить и проверить
- Создайте папку плагина, положите в нее три файла и папку resources с иконками и установите плагин по инструкции Установка и удаление плагина ↗.
- Откройте документ и на вкладке Плагины нажмите Дата в контекстном меню. Панель не откроется, а кнопка плагина останется нажатой — плагин работает.
- Щелкните правой кнопкой мыши в тексте, в ячейке или в надписи на слайде и выберите Вставить дату.
Чтобы выключить плагин, снова нажмите его кнопку на вкладке Плагины. После изменения code.js плагин нужно выключить и включить заново, иначе работает старая версия кода. Если пункт не появляется, откройте консоль по инструкции Отладка плагина ↗.
Результат
Во всех трех редакторах пункт «Вставить дату» появляется в конце контекстного меню.
Документы: меню и результат.


Таблицы: пункт в меню ячейки. Редактор распознает вставленную строку как дату: в узком столбце она отображается как ########, пока столбец не расширить.

Презентации: меню и результат в подзаголовке слайда.


Как доработать
- Подменю. У пункта может быть свой список items: сделайте пункт «Вставить дату» с вариантами «Сегодня», «Завтра», «Дата и время» и привяжите к каждому свой
attachContextMenuClickEvent. - Пункт для выделения. При type равном
Selectionпоказывайте другой пункт, например «Исправить типографику» из примера «Обработка выделенного текста» ↗.













