【alert】簡易なダイアログボックスを表示させる

GoogleAppsScript

【alert】メソッドは

Google スプレッドシート等の画面上でアラート通知のダイアログボックスを表示させることができるメソッド

です。

公式リファレンスの該当ページはこちら

 

また、類似のメソッドとして、文字入力を求めるダイアログボックスを表示させることができるpromptメソッドというものもあります。詳細についてはpromptのページでまとめてあります。

 

クラス

【Uiクラス】

Google スプレッドシート、Google ドキュメント、Google スライド、Google フォームのサービスでContainer bound Scriptでのスクリプトファイルでプログラミングをしている場合のみ、

SpreadsheetAppクラスなど各サービスの一番親となるクラスオブジェクトに対してgetUiメソッドを利用することでUiクラスを取得できます。

getUiメソッドのページでも詳しく解説しております。

 

記述方法

alertメソッドには引数の数によって記述方法が3種類に分類されます。

Uiクラスのメソッドであるため、Uiクラスのオブジェクトに対してalertメソッドを書く点については3つとも同じです。

alert(prompt)

まずは一番シンプルな記述方法その1です。こちらのパターンでは引数はpromptの1つだけになります。

引数promptには”アラート通知で表示させたいテキスト”を記入します。

例えば、引数promptに”これはテストです”で設定すると以下のようなアラート通知が表示されます。
alert02

 

alert(prompt, buttons)

次に記述方法その2です。こちらのパターンでは引数がpromptとbuttonsの2つに増えます。

引数promptに入力する内容とその効果は記述方法その1と同じです。ここでは引数buttonsについてご説明いたします。

 

引数buttonsにはGoogle Apps Scriptが提供している設定値を入力することでアラート通知で表示するボタンを変更することができます。

この、Google Apps Scriptが提供している設定値ですが、ButtonSetというEnum(※利用できる設定値の集まりのこと)で用意されており、以下のGoogle Apps Scriptのリファレンスページに詳細が記載されています。

 

alertで利用ができるButtonSetの値とそれを入力することにより表示されるボタンの値を下記の表にまとめました。(※日本語版での表示内容です。当然ですが、設定言語により表示される値は違います)

入力値 表示される値
OK **「OK」**
OK_CANCEL **「OK]「キャンセル」**
YES_NO **「はい」「いいえ」**
YES_NO_CANCEL **「はい」「いいえ」「キャンセル」**

 

 

下図は引数promptに”プログラミング初心者ですか?”、引数buttonsに”YES_NO”を設定した場合のアラート表示です。

alert03

 

また、ButtonSetで入力された値はGoogle Apps Scriptで用意されているButtonを使うことで、入力された値の確認や判定を行うことができます。

詳しくは下図のButtonの記事にまとめてありますので参考にしてみてください。この記事の活用事例のところでも使い方をご紹介しております。

 

alert(title, prompt, buttons)

最後に記述方法その3です。さらに引数titleが追加されました。

引数titleに値を設定することで、その値がアラート通知の左上に太字で表示されます。その他の引数prompt、buttonsはこれまでご説明した内容と同様です。

 

下図は引数titleに”alertテスト”、引数promptに”プログラミング初心者ですか?”、引数buttonsに”YES_NO”を設定した場合のアラート表示です。

alert04

 

戻り値

【Button】

alertメソッドでは簡易なダイアログボックスを表示させる…だけでなく、ボックス内でクリックされたボタンの情報をあとから取得することができます。そのボタンのクリック情報を格納したものがButtonです。

 

このButtonデータはalertメソッドが書かれたコードを変数に格納することで取得することができます。

取得したButtonは例えば「Button.YES」などと比較することでクリックされたボタンの判定を行うことが可能です。

Buttonを取得したあとの詳しい使い方についてはButtonのページに詳しく記載しておりますので確認してみてください!

使用例

「本当に削除してよろしいですか?」メッセージの実装

スプレッドシートのシート上のデータをすべて削除するプログラムを実装します。このプログラムを実装する上で心配なのはうっかり処理開始ボタンを押してしまうなどして望まないデータ削除をしてしまうこと…。

そんなことにならないように、処理開始ボタンを押したときに「本当に削除してよろしいでしょうか?」とアラート表示されて、「はい」のボタンを押した場合のみ削除を行なう…という仕組みを実装します。

このように、念の為の確認通知はいろんな処理の実装で応用することができますので、覚えておくと良いでしょう。

このコードを実装することで、削除処理を行おうとした際には以下のアラートが表示されます。

 

「はい」をクリックするとそのまま削除処理が実行され、「いいえ」をクリックすると以下のように処理はキャンセルされましたというメッセージが表示されデータの削除がされずに処理を終了します。

 

関連メソッド

以下のメソッドも確認しておくと、よりalertを活用することが可能です。(後日追加予定)

yoshi

JavaScript、Google Apps Scriptがメイン。Pythonもちょっとだけ。Google Apps Script開発、Pythonスクレイピングなどをする機会が多いです。ご依頼なども承っております。 記事内容についてのご意見・ご指摘などいただけますと幸いです。

シェアする

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

コメントする