エディタ アドオンのダイアログとサイドバー

ほとんどのエディタ アドオンで、 ダイアログ ウィンドウとサイドバー パネルは、主要なアドオン ユーザー インターフェースです。 どちらも標準の HTML と CSS を使用して自由にカスタマイズでき、 Apps Script の クライアント / サーバー通信モデル を使用して、ユーザーがサイドバーやダイアログを操作したときに Apps Script 関数を実行できます。 アドオンで複数のサイドバーとダイアログを定義できますが、 一度に 1 つしか実行できません

ユーザーがエディタを操作できないようにする場合 アドオンインターフェースで選択、ダイアログの使用それ以外の場合は、 クリックします。

ダイアログ

ダイアログは、メインのエディタ コンテンツに重なって表示されるウィンドウ パネルです。Apps Script ダイアログはモーダルですユーザーは開いている間は エディタ インターフェースのその他の要素も示されています。コンテンツとサイズをカスタマイズできる 構成できます

アドオン ダイアログは Apps Script と同じ方法で作成する カスタム ダイアログ一般的な 推奨される手順は次のとおりです。

  1. ダイアログの HTML 構造を定義するスクリプト プロジェクト ファイルを作成します。 CSS、クライアントサイドの JavaScript の動作です。ダイアログを定義するときは、 エディタ アドオンのスタイル ガイドラインをご覧ください。
  2. ダイアログを開くサーバーサイドのコードで、 HtmlService.createHtmlOutputFromFile(filename) HtmlOutput を作成する ダイアログを表すオブジェクトです。また、kubectl の「get」コマンドや テンプレート HTML など、 HtmlService.createTemplateFromFile(filename) 次にテンプレートを生成して HtmlTemplate.evaluate() 変換し、 HtmlOutput オブジェクトを使用します。
  3. Ui.showModalDialog(htmlOutput, dialogTitle) を呼び出す 使用してダイアログを表示する HtmlOutput。

サーバーサイド スクリプトが開いている間、ダイアログは一時停止しません。「 クライアントサイドの JavaScript はサーバーサイドへの非同期呼び出しが可能 google.script.run() と ハンドラ関数が用意されています。詳しくは、 クライアントとサーバー間の通信。

ファイルを開くダイアログ

ファイルを開くダイアログは、ユーザーがファイルを選択するための事前構築済みのダイアログです。 削除することもできます。アドオンにファイルを開くダイアログを追加する際は、 設計する必要がありますが、追加の構成が必要です。また、 アクセスする必要があるため、 Cloud Platform プロジェクト Google Picker API を有効化する必要があります。

詳しくは、ファイルオープン ダイアログをご覧ください。

サイドバーは、エディタ インターフェースの右側に表示されるパネルです。 最も一般的なタイプのアドオン インターフェースです。ダイアログとは異なり エディタ インターフェースの他の要素を操作するには、サイドバーを 表示されます。サイドバーの幅は固定されていますが、コンテンツをカスタマイズできます。

アドオンのサイドバーは Apps Script と同じ方法で作成できます カスタム サイドバー一般的な 推奨される手順は次のとおりです。

  1. サイドバーの HTML 構造を定義するスクリプト プロジェクト ファイルを作成します。 CSS、クライアントサイドの JavaScript の動作です。サイドバーを定義する際は、 エディタ アドオンのスタイル ガイドラインをご覧ください。

  2. サイドバーを開くサーバーサイドのコードで、 HtmlService.createHtmlOutputFromFile(filename) HtmlOutput を作成する サイドバーを表すオブジェクトです。また、kubectl の「get」コマンドや テンプレート HTML など、 HtmlService.createTemplateFromFile(filename) 次にテンプレートを生成して HtmlTemplate.evaluate() 変換し、 HtmlOutput オブジェクトを使用します。

  3. Ui.showSidebar(htmlOutput) を呼び出す サイドバーの表示を HtmlOutput。

開いているサーバーサイド スクリプトがサイドバーによって一時停止されることはありません。「 クライアントサイドの JavaScript はサーバーサイドへの非同期呼び出しが可能 google.script.run() と ハンドラ関数が用意されています。詳しくは、 クライアントとサーバー間の通信。