【ButtonSet】alertメソッド等で表示させるウインドウにボタンを実装する

GoogleAppsScript

【ButtonSet】は

alert、promptメソッドで表示させるダイアログボックスに設定することができるボタンの種類を集めたEnum

です。

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

基本情報

Enum

ButtonSetはalertやpromptメソッドでダイアログボックスを作成する場合において、「はい」や「いいえ」などのボタンを設置するプロパティ値をまとめたEnumです。

alertやpromptメソッド専用で用意されたenumであるため、他のメソッドなどで活用する場面は今のところありません。(2018年8月現在)

 

Enum Buttonについて

Google Apps ScriptではButtonSetで設定されたボタンの中からどのボタンを押したのかを判別するために利用できるButtonというEnumも用意されています。

使い方なども含めて詳しくはButtonの記事をご覧ください。

記述方法

ButtonSetで用意されているプロパティ値とそれを入力することで設定されるボタンについて下表にまとめました。また、実際に表示されるボタンをコードと一緒にお見せいたします。

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

 

OK

 

OK_CANCEL

 

YES_NO

 

YES_NO_CANCEL

使用例

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

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

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

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

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

 

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

関連メソッド

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

yoshi

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

シェアする

コメントを残す

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

コメントする