API автоматизации

Распечатать/сохранить в PDF

Connector — это класс, который позволяет взаимодействовать с текстовыми документами, электронными таблицами, презентациями и заполняемыми формами извне. Чтобы создать коннектор, используйте метод createConnector объекта редактора документов:

var connector = docEditor.createConnector()

Обратите внимание, что коннектор доступен только для Р7 Developer Edition.
Коннектор имеет тот же интерфейс, что и плагины. Ниже вы можете найти методы, доступные для этого класса.

• attachEvent — добавить прослушиватель событий.
• callCommand — отправить данные обратно в редактор.
• connect -подключите коннектор к редактору.
• detachEvent — удалить прослушиватель событий.
• disconnect — отключите коннектор от редактора.
• executeMethod — выполнять определенные методы редактора с помощью коннектора.

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

• attachEvent — функция, вызываемая для добавления слушателя события, функция, которая будет вызываться всякий раз, когда указанное событие будет доставлено к таргету. Список всех доступных событий такой же, как и для плагинов. Его можно найти здесь.
• Параметры

  Название	Описание	Тип
  name	Название события.	строковый
  callback	Слушатель события.	функциональный

  Пример

  connector.attachEvent("onChangeContentControl", function()
  {
      console.log("event: onChangeContentControl");
  });
  

• callCommand —  функция, вызываемая для отправки данных обратно в редактор. Он позволяет коннектору отправлять структурированные данные, которые можно вставить в результирующий файл документа (форматированные абзацы, таблицы, текстовые части, отдельные слова и т. д.).
• Document Builder Команды можно использовать только для создания контента и вставки его в редактор документов (используя Api.GetDocument().InsertContent(…)). Это ограничение существует из-за функции совместного редактирования в онлайн-редакторах.
  Параметры

  Название	Описание	тип
  command	Определяет команду, написанную на JavaScript, целью которой является формирование структурированных данных, которые могут быть вставлены в результирующий файл документа (форматированные абзацы, таблицы, текстовые части, отдельные слова и т. д.). Затем данные отправляются в редакцию. Команда должна быть совместима с синтаксисом Document Builder	функциональный
  callback	Результат, который возвращает метод. Это необязательный параметр.	функциональный
  isNoCalc	Определяет, будет ли документ пересчитываться или нет. Значение true используется для пересчета документа после выполнения функции в параметре команды. Значение false не будет пересчитывать документ (используйте его только тогда, когда ваши правки точно не потребуют пересчета документа). Значение по умолчанию false.	логический

• Этот метод выполняется в своем контексте, изолированном от других данных JavaScript. Если в этот метод нужно передать какие-то параметры или другие данные, используйте объект Asc.scope.
  Пример

  Asc.scope.text = "Hello world!"; 
  
  connector.callCommand(function() {
  
      var oDocument = Api.GetDocument();
      var oParagraph = Api.CreateParagraph();
      oParagraph.AddText(Asc.scope.text);
      oDocument.InsertContent([oParagraph]);
  
  }, function() { console.log("callback command"); });
  

• connect — функция, вызываемая для подключения коннектора к редактору.
  Обратите внимание, что этот метод следует вызывать только в том случае, если вы отключили коннектор с помощью метода разъединения и вам нужно снова подключить его к редактору. При создании коннектора не нужно использовать метод connect, так как он вызывается автоматически вместе с методом createConnector.
  Пример

  connector.connect()
  

• detachEvent — функция, вызываемая для удаления прослушивателя событий.
  Параметры

  Название	Описание	Тип
  name	Название события.	строковый

  Пример

  connector.detachEvent("onChangeContentControl");
  

• disconnect -функция, вызываемая для отключения коннектора от редактора.
  Пример

  connector.disconnect()
  

• executeMethod — функция, вызываемая для выполнения определенных методов редактора с использованием коннектора. Полный список этих методов такой же, как и для плагинов. Его можно найти здесь.
  Параметры

  Название	Описание	Тип
  name	Имя конкретного метода, который должен быть выполнен.	строковый
  args	Аргументы используемого метода (если они есть).	массив
  callback	Результат, который возвращает метод. Это необязательный параметр.	функциональный

  Пример

  connector.executeMethod("SetFormValue",[forms[i]["InternalId"],"Р7 BANK"],null);