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

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

Обновлено: 18.11.26

Задача

Плагин заменяет заданный текст во всем документе, например «ООО» на «АО», с учетом или без учета регистра. После замены курсор возвращается в начало документа. Кнопка замены становится доступна, только когда документ полностью загружен.

Редактор: Документы.

Методы и события

ЧтоЗачем в примере
SearchAndReplaceПринимает объект { searchString, replaceString, matchCase } и заменяет все вхождения сразу. Если matchCase не передать, регистр учитывается.
MoveCursorToStartСтавит курсор в начало документа. В примере вызывается с параметром true.
Событие onDocumentContentReadyДокумент загружен. Если плагин запущен позже, редактор присылает событие сразу после запуска.

Подробности о методах — в статье executeMethod: методы по задачам ↗, о событии — в статье События плагинов ↗.

Код плагина

Плагин состоит из трех файлов и папки с иконками. GUID в config.json у каждого плагина свой: для своего плагина сгенерируйте новый.

config.json

{
    "name": "Find and replace",
    "nameLocale": { "ru": "Найти и заменить" },
    "guid": "asc.{6E98EDD1-EDAB-4536-BA8C-5452301DC504}",
    "version": "1.0.0",
    "variations": [
        {
            "description": "Replaces text throughout the document",
            "descriptionLocale": { "ru": "Заменяет текст во всем документе" },
            "url": "index.html",
            "icons": [ "resources/icon.png", "resources/icon@2x.png" ],
            "isViewer": false,
            "EditorsSupport": [ "word" ],
            "isVisual": true,
            "isModal": false,
            "isInsideMode": true,
            "initDataType": "none",
            "initData": "",
            "buttons": [],
            "events": [ "onDocumentContentReady" ]
        }
    ]
}

index.html

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Find and replace</title>
    <script type="text/javascript" src="../v1/plugins.js"></script>
    <script type="text/javascript" src="../v1/plugins-ui.js"></script>
    <link rel="stylesheet" href="../v1/plugins.css">
    <script type="text/javascript" src="code.js"></script>
</head>
<body style="padding: 12px;">
    <label for="find">Найти</label>
    <input id="find" class="form-control" style="width: 100%; margin: 4px 0 8px;" value="ООО">
    <label for="replace">Заменить на</label>
    <input id="replace" class="form-control" style="width: 100%; margin: 4px 0 8px;" value="АО">
    <label style="display: block; margin-bottom: 12px;"><input id="case" type="checkbox" checked> Учитывать регистр</label>
    <button id="run" class="btn-text-default" style="width: 100%; margin-bottom: 12px;" disabled>Заменить все</button>
    <p id="status" style="color: #7d858c;">Ждем загрузки документа...</p>
</body>
</html>

code.js

// Пример «Найти и заменить». Автор: Александр Поляков
(function (window) {
    function setStatus(text) {
        document.getElementById("status").textContent = text;
    }

    function replaceAll() {
        var searchString = document.getElementById("find").value;
        var replaceString = document.getElementById("replace").value;
        if (!searchString) {
            setStatus("Введите текст для поиска.");
            return;
        }
        window.Asc.plugin.executeMethod("SearchAndReplace", [{
            searchString: searchString,
            replaceString: replaceString,
            matchCase: document.getElementById("case").checked
        }], function () {
            // Возвращаем курсор в начало документа
            window.Asc.plugin.executeMethod("MoveCursorToStart", [true]);
            setStatus("Готово: «" + searchString + "» заменено на «" + replaceString + "».");
        });
    }

    window.Asc.plugin.init = function () {
        document.getElementById("run").onclick = replaceAll;
    };

    // Кнопка станет доступна, когда документ полностью загрузится
    window.Asc.plugin.event_onDocumentContentReady = function () {
        document.getElementById("run").disabled = false;
        setStatus("Документ загружен.");
    };

    window.Asc.plugin.button = function () {
        this.executeCommand("close", "");
    };
})(window);

Как установить и проверить

  1. Создайте папку плагина, положите в нее три файла и папку resources с иконками и установите плагин по инструкции Установка и удаление плагина ↗.
  2. Наберите в документе текст, где есть «ООО» и «ооо».
  3. На вкладке Плагины нажмите Найти и заменить. В панели появится «Документ загружен», и кнопка станет доступна.
  4. Нажмите Заменить все.

Если кнопка остается неактивной, проверьте массив events в config.json и откройте новый документ: редактор читает config.json при открытии документа. Ошибки в коде смотрите в консоли по инструкции Отладка плагина ↗.

Результат

До замены: документ загружен, кнопка доступна.

После замены: оба «ООО» заменены на «АО», «ооо» строчными осталось без изменений, курсор в начале документа.

Как доработать

  • Список замен. Храните пары «что → на что» в массиве и вызывайте SearchAndReplace для каждой пары по очереди: так можно обновить реквизиты или термины в документе за одно нажатие.
  • Автоматическая замена при открытии. Вызовите замену прямо в event_onDocumentContentReady, без кнопки.

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

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

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