メニューを操作する

【GAS】スプレッドシートにメニューを追加する

GASでスプレッドシートにメニューを追加するには「createMenu(caption) 」を利用する。

createMenu(caption)

エディタのユーザー インターフェースにメニューを追加するために使用できるビルダーを作成します。Menu.addToUi() が呼び出されるまで、実際にはメニューは追加されません。詳しくは、メニューガイドをご覧ください。トップレベル メニューのラベルは見出しケース(すべての主要単語を大文字)にする必要がありますが、サブメニューのラベルは文頭を大文字にします(最初の単語のみを大文字にします)。スクリプトがアドオンとして公開されている場合、caption パラメータは無視され、メニューはアドオンメニューのサブメニュー(createAddonMenu() と同等)として追加されます。

https://developers.google.com/apps-script/reference/base/ui#createmenucaption

スプレッドシートにメニューを追加するGAS実行の様子

createMenu(caption) メソッドを利用して、スプレッドシートにメニューを追加するGASを実行してみました。

createMenu(caption)を実行することで、

  • メニューバーに独自のオリジナルメニューを追加する

といった操作が可能です。

スプレッドシートでチェックボックスを全て削除する場合は、以下記事を御覧ください。

参照記事:【GAS】スプレッドシートでチェックボックスを全て削除する

スプレッドシートにメニューを追加するGAS

//--スプレッドシートにオリジナルメニューを作成
    function onOpne(e){
    //SpreadSheetAppを起動してgetUiでインターフェイスを操作
     SpreadsheetApp.getUi()
    //■createMenuでOYAKUN用メニュー作成
     .createMenu('OYAKUN用')
    //addItemでアラートのfunctionを呼び出し
     .addItem('アラート1','test1')
    //addToUiでシートへメニューを追加
     .addToUi()
    }
     
    //--オリジナルメニューで実行されるfunction
    function test1(){
    //SpreadSheetAppを起動してgetUiでインターフェイスを操作
     const ui = SpreadsheetApp.getUi();
    //ui.alertでアラート中の文言を表示
     ui.alert('test1のアラートです');
    }
    

createMenu(caption)のパラメーター

名前説明
captionStringメニューのラベル(最上位のメニューはすべて大文字にする、またはサブメニューの最初の単語を大文字にする)
createMenu(caption)のパラメーター

createMenu(caption)の戻り値

Menu - 新しいメニュー ビルダー。

スプレッドシートにメニューを追加するまとめ

GAS×スプレッドシートにメニューを追加するならcreateMenu(caption)メソッドを利用しましょう。

関連記事:【GAS】スプレッドシートの文字を折り返す

関連記事:【GAS】スプレッドシートの文字の折返しを配列で設定する

関連記事:【GAS】スプレッドシートの文字の折返し方法を設定する

関連記事:【GAS】スプレッドシートの文字を斜めにする

-メニューを操作する