【GAS】スプレッドシートでアクティブシートのインデックス番号を取得する

2024年10月8日

GASでスプレッドシートで選択シートのインデックス番号を取得するには「getIndex()」を利用する。

getIndex()
親スプレッドシート内のシートの位置を取得します。1から始まります。
https://developers.google.com/apps-script/reference/spreadsheet/sheet?hl=en#getindex

スプレッドシートで選択シートのインデックス番号を取得するGAS実行の様子

getIndex()メソッドを利用して、スプレッドシートで選択シートのインデックス番号を取得するGASを実行してみました。

スプレッドシートで選択シートのインデックス番号を取得するGAS

function myFunction() {
  var ss = SpreadsheetApp.getActiveSpreadsheet(); //SpreadSheetApp有効に
  var sht = ss.getSheets()[0]; //0番目のシートを取得
  var sheet1 = "シート"; 　　　　//テキスト"シート"を格納
  var shtname = sht.getSheetName(); //0番目のシート名を取得
  if(shtname != sheet1) {  //shtのシート名がシートでない場合
      sht.setName(sheet1);　//シート名を"シート"へ変更する
  }
    for(var i=1; i<4; i++){　　 　//繰返し処理
    　ss.insertSheet("シート"+i); //insertSheetでシートを繰返し処理分、新規作成する
    }
  var shtindex = ss.getActiveSheet().getIndex()-1; //getIndexでアクティブシートの数を取得
  Browser.msgBox("アクティブなシートは「シート"+shtindex+"」です！")//メッセージを掲載！
}