Описание. Добавляет пункты плагина в контекстное меню. Вызывается только в обработчике события onContextMenuShow. Пункты появляются в конце меню, после стандартных.
Редакторы: документы, таблицы, презентации.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| guid | строка | GUID плагина: window.Asc.plugin.guid |
| items | массив | Пункты меню (свойства — в таблице выше). Пустой массив означает «на этот раз пунктов нет» |
Оба свойства передаются одним объектом: [{ guid: ..., items: [...] }].
Возвращаемое значение
Метод ничего не возвращает: в функцию обратного вызова приходит undefined.
Пример
Добавить пункт с вложенным меню и передать формат даты в data:
window.Asc.plugin.attachEvent("onContextMenuShow", function (options) {
window.Asc.plugin.executeMethod("AddContextMenuItem", [{
guid: window.Asc.plugin.guid,
items: [
{ separator: true },
{
id: "insertDate",
text: "Вставить дату",
items: [
{ id: "insertDate", text: "ДД.ММ.ГГГГ", data: "short" },
{ id: "insertDate", text: "С названием месяца", data: "long" }
]
}
]
}]);
});
window.Asc.plugin.attachContextMenuClickEvent("insertDate", function (format) {
var date = format === "long"
? new Date().toLocaleDateString("ru-RU", { day: "numeric", month: "long", year: "numeric" })
: new Date().toLocaleDateString("ru-RU");
window.Asc.plugin.executeMethod("PasteText", [date]);
});Как плагин добавляет пункты в контекстное меню
Пункты нельзя добавить заранее. Когда пользователь открывает контекстное меню, редактор отправляет плагину событие onContextMenuShow, и плагин в ответ передает свои пункты через AddContextMenuItem. Вызов AddContextMenuItem вне этого события ничего не добавляет.
Порядок работы:
- В config.json подписаться на события:
"events": ["onContextMenuShow", "onContextMenuClick"]. - В обработчике onContextMenuShow вызвать AddContextMenuItem со списком пунктов.
- Нажатие на пункт обработать через
window.Asc.plugin.attachContextMenuClickEvent(id, function (data) {...}).
Плагин должен отвечать на каждое открытие меню, даже пустым списком: редактор добавляет пункты плагинов в меню только после того, как ответят все плагины, подписанные на событие. Стандартные пункты меню показываются в любом случае.
Полный пример плагина — в статье «Пункт в контекстном меню» рубрики «Примеры плагинов».
Свойства пункта меню
| Свойство | Тип | Описание |
|---|---|---|
| id | строка | Идентификатор пункта. По нему подключается обработчик нажатия и находится пункт при обновлении |
| text | строка или объект | Надпись пункта. Можно передать объект с переводами, например { "ru": "Вставить", "en": "Insert" }: редактор возьмет текст на языке интерфейса, а если его нет — английский |
| data | строка | Необязательно. Строка, которая придет в обработчик нажатия |
| disabled | логический | Необязательно. Пункт виден, но недоступен |
| items | массив | Необязательно. Пункты вложенного меню с теми же свойствами |
| separator | логический | Пункт { separator: true } добавляет разделительную линию. У такого пункта другие свойства игнорируются: текст не показывается |
В Таблицах из объекта с переводами берется английский текст даже при русском интерфейсе. Если плагин работает в Таблицах, передавайте в text строку на нужном языке.













