Методы - Центр поддержки Р7

После инициализации редактора документов вы получите объект, который можно использовать для вызова методов.

  • denyEditingRights — запретить редактирование.
  • destroyEditor -уничтожить объект docEditor.
  • downloadAs — скачать отредактированный файл.
  • insertImage — вставьте изображение в файл.
  • refreshHistory — показать историю версий документа.
  • requestClose — запрос на закрытие редактора.
  • setActionLink — установить ссылку на документ, содержащий закладку.
  • setFavorite — изменить состояние «Избранного» значка.
  • setHistoryData — отправить ссылку на документ для просмотра истории версий.
  • setMailMergeRecipients -вставить данные получателя для слияния в файл.
  • setRevisedFile — выбрать документ для сравнения.
  • setSharingSettings — обновить информацию о настройках, позволяющих поделиться документом с другими пользователями.
  • setUsers — установить список пользователей для упоминания в комментариях.
  • showMessage — отображать всплывающую подсказку с сообщением.

Методы и их описание:

var docEditor = new DocsAPI.DocEditor("placeholder", config);
  • denyEditingRights — запретить редактирование. Данный метод может быть вызван, когда вы хотите сделать невозможным редактирование документа.
    docEditor.denyEditingRights(message);
    Параметр Описание Тип Наличие
    message Определяет тексты сообщений для диалогов. строка необязательный
  • destroyEditor — уничтожить объект docEditor. Данный метод может быть вызван, если вы хотите заново инициализировать редактор документов с иной конфигурацией. Данный метод не используется.
    docEditor.destroyEditor();
  • downloadAs — скачать отредактированный файл. Этот метод может быть вызван только при существовании события onDownloadAsСервис редактирования документов асинхронно создаёт документ и вызывает событие onDownloadAs со ссылкой в параметре.
    docEditor.downloadAs();
    Параметр описание Тип наличие
    format Определяет формат, в котором будет загружен файл. Все возможные форматы вы можете найти в таблицах конверсии. Но вы не можете скачать файл в таких форматах изображения, как bmp, gif, jpg, png. Если этот параметр не определен, файл будет загружен в формате OOXML в соответствии с типом файла. строковый обязательный
  • insertImage — Вставить изображение в файл. Этот метод может быть вызван после событий onRequestInsertImage.
    docEditor.insertImage({
        "fileType": "png",
        "url": "https://example.com/url-to-example-image.png"
    });

    Где example.com — это имя, где установлены менеджер документов и сервис хранения документов. Перейдите в раздел Как это работает, чтобы узнать больше о взаимодействии службы Сервера документов с клиентским сервером.

    Параметр Описание Тип Наличие
    c Определяет тип вставки изображения из события. Может быть: добавление, изменение, заполнение, водяной знак, слайд. Значение по умолчанию — «добавить». строковый обязательный
    fileType Определяет тип изображения, которое будет вставлено в файл. Может быть: bmp, gif, jpeg, jpg, png. Устарел, начиная с версии 7.0. Вместо этого используйте параметр images.fileType. строковый обязательный
    images Определяет массив изображений для вставки. массив объектов обязательный
    images.fileType Определяет тип изображения, которое будет вставлено в файл. Может быть: bmp, gif, jpeg, jpg, png. строковый обязательный
    images.url Определяет абсолютный URL-адрес, где хранится исходное изображение. Обязательно добавляйте токен при использовании локальных ссылок. строковый обязательный
    token Определяет зашифрованную подпись, добавляемую к параметру в виде token. строковый необязательный
    url Определяет абсолютный URL-адрес, где хранится исходное изображение. Обязательно добавляйте token при использовании локальных ссылок. В противном случае произойдет ошибка. Устарело, начиная с версии 7.0. Вместо этого используйте параметр images.url. строковый обязательный

     

    До версии 7.0 этот метод позволял вставлять только одно изображение и имел следующие параметры:

    docEditor.insertImage({
        "c": "add",
        "fileType": "png",
        "url": "https://example.com/url-to-example-image.png"
    });
    

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

  • refreshHistory — показывает историю версий документа. Данный метод необходимо вызывать после событий onRequestHistory.