ONLYOFFICE Automation API - ONLYOFFICE’s diary

コネクタは、テキスト文書、スプレッドシート、プレゼンテーション、および記入可能なフォームを外部から操作できるようにするクラスです。コネクタを作成するには、ドキュメント・エディタのオブジェクトのcreateConnectorメソッドを使用します。

var connector = docEditor.createConnector()

このコネクタはONLYOFFICE Developer Editionでのみ利用可能です。

このクラスは、追加料金で利用できる機能です。ご不明な点がございましたら、弊社営業部（sales@onlyoffice.com）までお問い合わせください。

コネクタは、プラグインと同じインターフェイスを持っています。以下、このクラスで利用可能なメソッドを紹介します。

attachEvent - イベントリスナーを追加する。
callCommand - エディタにデータを送り返す。
connect - エディタにコネクタを接続する。
detachEvent - イベント・リスナーを削除する。
disconnect - エディタからコネクタを切り離す。
executeMethod - コネクタを使用して特定のエディタメソッドを実行する。

メソッドとその説明

attachEvent - イベントリスナーを追加するために呼び出される関数で、指定されたイベントがターゲットに配信されるたびに呼び出される関数です。利用可能なすべてのイベントのリストは、プラグインと同じです。詳しくは、ここに記載されています。

パラメーター

名前	説明	種類
name	イベントの名前	string（文字列）
callback	イベントのリスナー	function（関数）

例：

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

callCommand - データをエディタに送り返すために呼び出される関数です。これにより、コネクタは結果のドキュメントファイルに挿入できる構造化されたデータ（フォーマットされた段落、テーブル、テキスト部分、および個別の単語など）を送信することができます。

ONLYOFFICE Document Builderのコマンドは、コンテンツを作成し、ドキュメントエディタに挿入するためにのみ使用できます（Api.GetDocument().InsertContent(...)を使用します）。この制限は、オンラインエディターの共同編集機能によって存在します。

パラメーター

名前	説明	種類
command	JavaScriptで書かれたコマンドで、文書ファイルに挿入できる構造化データ（段落、表、テキスト部分、単語など）を形成することを目的としたコマンドを定義します。そして、そのデータは編集者に送られる。コマンドはONLYOFFICE Document Builderのシンタックスと互換性がある必要があります。	function（関数）
callback	メソッドが返す結果。オプションのパラメータです。	function（関数）
isNoCalc	ドキュメントの再計算を行うかどうかを定義する。trueを指定すると、commandパラメータで指定した関数を実行した後、ドキュメントを再計算します。falseを指定すると、ドキュメントの再計算は行われません（編集でドキュメントの再計算が確実に必要ない場合にのみ使用します）。デフォルト値はfalseです。	boolean

このメソッドは、他の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 - エディタにコネクタを接続するために呼び出される関数です。

このメソッドは、disconnectメソッドでコネクタを切断し、再びエディタに接続する必要がある場合にのみ呼び出す必要があることにご注意ください。コネクタを作成する場合、connectメソッドはcreateConnectorメソッドと一緒に自動的に呼び出されるため、使用する必要はありません。

例：

connector.connect()

detachEvent - イベントリスナーを削除するために呼び出される関数です。

パラメーター

名前	説明	種類
name	イベントの名前	string（文字列）

例：

connector.detachEvent("onChangeContentControl");

disconnect - エディタからコネクタを切断するために呼び出される関数です。

例：

connector.disconnect()

executeMethod - コネクタを使用して特定のエディタメソッドを実行するために呼び出される関数です。これらのメソッドの完全なリストは、プラグインと同じです。詳しくは、ここに記載されています。

パラメーター

名前	説明	種類
name	実行しなければならない特定のメソッドの名前	string（文字列）
args	使用中のメソッドが持っている引数（ある場合）	array
callback	メソッドが返す結果。オプションのパラメータです。	function（関数）

例：

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