Продукты Р7
Корпоративный сервер 2024
Корпоративный сервер 2024
Сервер документов
Сервер документов
Редакторы документов
Редакторы документов
Корпоративный сервер 2019
Корпоративный сервер 2019
Графика
Графика
ВКС и мессенджер
ВКС и мессенджер
Мобильные редакторы
Мобильные редакторы
Почтовый сервер
Почтовый сервер
Органайзер
Органайзер
Сервер лицензирования
Сервер лицензирования
Файл-Экспресс
Файл-Экспресс
Аналитика
Аналитика
Дополнительно
Часто задаваемые вопросы
Разработчикам
Интеграции
Новые возможности

AddContextMenuItem

Обновлено: 18.11.26

Описание. Добавляет пункты плагина в контекстное меню. Вызывается только в обработчике события 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 вне этого события ничего не добавляет.

Порядок работы:

  1. В config.json подписаться на события: "events": ["onContextMenuShow", "onContextMenuClick"].
  2. В обработчике onContextMenuShow вызвать AddContextMenuItem со списком пунктов.
  3. Нажатие на пункт обработать через window.Asc.plugin.attachContextMenuClickEvent(id, function (data) {...}).

Плагин должен отвечать на каждое открытие меню, даже пустым списком: редактор добавляет пункты плагинов в меню только после того, как ответят все плагины, подписанные на событие. Стандартные пункты меню показываются в любом случае.

Полный пример плагина — в статье «Пункт в контекстном меню» рубрики «Примеры плагинов».

Свойства пункта меню

СвойствоТипОписание
idстрокаИдентификатор пункта. По нему подключается обработчик нажатия и находится пункт при обновлении
textстрока или объектНадпись пункта. Можно передать объект с переводами, например { "ru": "Вставить", "en": "Insert" }: редактор возьмет текст на языке интерфейса, а если его нет — английский
dataстрокаНеобязательно. Строка, которая придет в обработчик нажатия
disabledлогическийНеобязательно. Пункт виден, но недоступен
itemsмассивНеобязательно. Пункты вложенного меню с теми же свойствами
separatorлогическийПункт { separator: true } добавляет разделительную линию. У такого пункта другие свойства игнорируются: текст не показывается

В Таблицах из объекта с переводами берется английский текст даже при русском интерфейсе. Если плагин работает в Таблицах, передавайте в text строку на нужном языке.

Была ли эта статья полезной?

Поделитесь пожалуйста своим мнением

      В статье есть ошибкиРекомендации не помоглиТекст трудно понятьСодержание статьи не соответствует заголовкуДругое