スポンサーリンク

テキスト入力付きダイアログボックスの表示(Uiオブジェクト)

Google App Script(GAS)で、Uiオブジェクトでブラウザにテキスト入力付きのダイアログボックスを表示する構文です。

Uiオブジェクトでダイアログボックスを表示する構文はこちらを参照してください。

構文

Uiオブジェクト.prompt(prompt)

Uiオブジェクト.prompt(prompt, buttons)

Uiオブジェクト.prompt(title, prompt, buttons)

引数

引数説明
titleStringタイトル
promptString表示するテキスト
buttonsButtonSetボタンのタイプ

ボタンのタイプ

プロパティ説明
Uiオブジェクト.ButtonSet.OKEnum「OK」ボタンのみ
Uiオブジェクト.ButtonSet.OK_CANCELEnum「OK」ボタンと「キャンセル」ボタン
Uiオブジェクト.ButtonSet.YES_NOEnum「はい」ボタンと「いいえ」ボタン
Uiオブジェクト.ButtonSet.YES_NO_CANCELEnum「はい」ボタンと「いいえ」ボタンと「キャンセル」ボタン

戻り値

PromptResponse

  • PromptResponseオブジェクトから入力されたテキストの取得をする構文はこちらを参照してください。
  • PromptResponseオブジェクトから操作されたボタンの取得をする構文はこちらを参照してください。

サンプル

function sample() {
  // Uiオブジェクトの作成
  const ui = SpreadsheetApp.getUi();

  // テキストのみ設定
  const res1 = ui.prompt("サンプル");
  Logger.log(res1);

  const res2 = ui.prompt("「OK」のみ", ui.ButtonSet.OK);
  Logger.log(res2);

  const res3 = ui.prompt("「OK」と「キャンセル」", ui.ButtonSet.OK_CANCEL);
  Logger.log(res3);

  const res4 = ui.prompt("「はい」と「いいえ」", ui.ButtonSet.YES_NO);
  Logger.log(res4);

  const res5 = ui.prompt("「はい」と「いいえ」と「キャンセル」", ui.ButtonSet.YES_NO_CANCEL);
  Logger.log(res5);

  // タイトルあり
  const res6 = ui.prompt("タイトル", "タイトル付き", ui.ButtonSet.OK_CANCEL);
  Logger.log(res6);

  // 表示するテキストに改行を入れる場合
  const res7 = ui.prompt("サンプル\\nテスト");
  Logger.log(res7);
}

解説

Browser.msgBox()と同じようにテキストボックス付きのダイアログボックスを表示します。戻り値はPromptResponseオブジェクトとなり、入力されたテキスト、押されたボタンをそれぞれ取得することが可能です。

ダイアログボックスへ表示するテキストに改行を入れたい場合は「\\n」を使用することで改行を入れることができます。

テキスト入力付きダイアログボックスの表示をする構文はこちらを参照してください。

スポンサーリンク
おすすめの記事