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

Отладка плагина

Обновлено: 16.11.26

Плагин — это веб-страница, поэтому отлаживается он теми же средствами, что и обычный сайт: через инструменты разработчика с консолью, точками останова и просмотром кода страницы. В Десктоп редакторах инструменты разработчика скрыты и включаются параметром запуска.

В статье описано, как запустить редактор в режиме отладки, открыть инструменты разработчика для плагина и найти причину типичных ошибок. В примерах используется плагин «Привет, мир» из статьи «Создание первого плагина».

Шаг 1. Запустите редактор в режиме отладки

  1. Закройте все окна Десктоп редакторов. Если редактор остался запущенным, следующий запуск откроет его же, и режим отладки не включится. Проверьте в Диспетчере задач, что не осталось процессов editors.exe и DesktopEditors.exe.
  2. Запустите редактор с ключом --ascdesktop-support-debug-info. В Windows нажмите Win+R и выполните:
    "C:\Program Files\R7-Office\Editors\DesktopEditors.exe" --ascdesktop-support-debug-info
  3. Щёлкните правой кнопкой по стартовой странице. Если режим включён, в меню есть пункты Show DevTools, Close DevTools и Inspect Element.

Режим действует до закрытия редактора. Чтобы запускать его так всегда, создайте ярлык и добавьте ключ в поле Объект в свойствах ярлыка.

Шаг 2. Откройте инструменты разработчика для плагина

  1. Откройте документ и запустите плагин.
  2. Щёлкните правой кнопкой по свободному месту в окне плагина и выберите Show DevTools. Откроется отдельное окно DevTools — такое же, как в браузере Chrome. На поле ввода щёлкать не нужно: там открывается обычное меню «Вырезать / Копировать / Вставить».
  3. Перейдите на вкладку Console.
  4. В списке контекстов слева над консолью (по умолчанию в нём выбрано top) выберите pluginFrameEditor.

Инструменты разработчика открываются для всего окна редактора, а плагин — лишь один из фреймов внутри него. В списке контекстов три строки:

КонтекстЧто это
topОкно редактора целиком
frameEditorРедактор документа
pluginFrameEditorВаш плагин: здесь доступны его переменные и объект Asc.plugin

В контексте pluginFrameEditor можно выполнять команды плагина прямо из консоли, например проверить GUID:

Asc.plugin.info.guid

На вкладке Sources можно открыть code.js и поставить точки останова, на вкладке Elements — посмотреть разметку и стили окна плагина.

В консоли от старта могут быть ошибки самого редактора, например «Failed to load resource: net::ERR_FILE_NOT_FOUND». К вашему плагину они не относятся.

Шаг 3. Выводите сообщения в консоль

Самый простой способ понять, что происходит, — console.log. Сообщения из кода плагина, из функции внутри callCommand и из callback попадают в одно окно DevTools:

console.log("Кнопка нажата");
window.Asc.plugin.callCommand(function () {
    console.log("Код выполняется в редакторе");
    return 42;
}, false, false, function (result) {
    console.log("Результат:", result);
});

В консоли появятся три строки, последняя — «Результат: 42».

Ошибки внутри callCommand

Если в функции внутри callCommand произошла ошибка, плагин об этом не узнаёт: в callback просто придёт undefined. Чтобы увидеть причину, перехватите ошибку и верните её текст:

window.Asc.plugin.callCommand(function () {
    try {
        var oDocument = Api.GetDocument();
        // ваш код
        return "ok";
    } catch (e) {
        return "Ошибка: " + e.message;
    }
}, false, true, function (result) {
    console.log(result);
});

Например, если запустить этот код в табличном редакторе, в консоли появится «Ошибка: Cannot read properties of undefined (reading ‘m_oLogicDocument’)»: метод Api.GetDocument работает только в редакторе документов.

Без режима отладки

Если запустить редактор с ключом нельзя, выводите сообщения прямо в окно плагина. Добавьте в index.html блок <div id="log"></div>, а в code.js — функцию:

function log(text) {
    document.getElementById("log").innerText += text + "\n";
}

И вызывайте log(...) вместо console.log(...). Так сообщения из кода плагина и из callback будут видны в окне плагина. Внутри функции callCommand функция log недоступна — возвращайте данные через return.

Шаг 4. Правьте код без переустановки

Удобнее всего править файлы прямо в папке установленного плагина: %LOCALAPPDATA%\R7-Office\Editors\data\sdkjs-plugins\{GUID} (подробнее — в статье «Установка и удаление плагина»).

  1. Измените и сохраните index.html или code.js.
  2. Закройте окно плагина и снова нажмите его кнопку на вкладке Плагины.

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

Изменения config.json (название, размер окна, кнопки и другие настройки) применяются иначе: только в документах, открытых после правки. В уже открытом документе плагин работает со старыми настройками, даже если закрыть и снова открыть плагин. Чтобы проверить правку, создайте или откройте другой документ — перезапускать редактор не нужно.

Частые ошибки

Что происходитПричинаКак исправить
Код в callCommand ничего не делает, в callback приходит undefinedВнутри функции произошла ошибка. Плагин об этом не узнаётОберните код в try/catch и верните текст ошибки через return (см. выше)
Внутри callCommand переменная плагина равна undefinedФункция выполняется в редакторе и не видит переменные плагинаПередайте данные через Asc.scope
Код работает в документах, но не в таблицахИспользованы методы Api для документов, например Api.GetDocumentПроверяйте info.editorType и вызывайте методы нужного редактора
Результат executeMethod равен undefinedРезультат читают сразу после вызова, а он приходит позжеИспользуйте результат внутри callback
Событие редактора не приходитСобытие не указано в config.jsonДобавьте его в параметр events вариации
GetSelectedText возвращает текст с лишним переводом строкиВ конце абзаца метод добавляет перевод строкиУберите его через text.trim()

Случаи из таблицы проверены в Десктоп редакторах 2026.3.1: первый, третий, четвёртый и шестой — вживую, второй и пятый — по коду редактора.

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

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

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