シートを操作する

【GAS】スプレッドシートに名前とオプションを指定した新規シートを挿入する

GASでスプレッドシートに名前とオプションを指定した新規シートを挿入するには「insertSheet(sheetName, options)」を利用する。

insertSheet(sheetName, options)

指定された名前で新しいシートをスプレッドシートに挿入し、オプションの高度な引数を使用します。新しいシートがアクティブシートになります。

https://developers.google.com/apps-script/reference/spreadsheet/spreadsheet#insertsheetsheetname,-options

スプレッドシートに名前とオプションを指定した新規シートを挿入するGAS実行の様子

insertSheet(sheetName, options)メソッドを利用して、スプレッドシートに名前とオプションを指定した新規シートを挿入するGASを実行してみました。

insertSheet(sheetName, options)-yes
insertSheet(sheetName, options)を実行した様子

insertSheet(sheetName, options)メソッドの()の値については、

  • sheetNameには任意のシート名を
  • optionsにはテンプレートとなるシートを

上記を各指定することで、テンプレートシートをコピー・任意の名前に変更されたシートが挿入されます。

insertSheet()メソッドでシート名とインデックスを指定したシート挿入を行う場合は、以下記事を御覧ください。

参照記事:【GAS】スプレッドシートに名前とインデックスを指定した新規シートを挿入する

スプレッドシートに名前とオプションを指定した新規シートを挿入するGAS

function insertshtnameopt(){
  //SpreadsheetAppを起動
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  //0番目のシート取得
  var sht = ss.getSheets()[0];
  //0番目のシートをテンプレートにする。メッセージ掲載のために名前を取得
  var tmpname = sht.getSheetName();
 //YES・Noで確認
 var yesno = Browser.msgBox("シート名を指定した「"+tmpname+"シート」のコピーを作成しますか?" ,Browser.Buttons.YES_NO_CANCEL);
 //ーーーーー条件分岐ーーーーー
  //YESだったら
    if(yesno=="yes"){
      //シート名を入力してもらう
      var text = Browser.inputBox("挿入するシートの名前を入力してください");
      //■insertSheetで名前とtemplateを指定した新規シートを挿入
        ss.insertSheet(text,{template:sht});
      //処理内容をメッセージで掲載
      Browser.msgBox("「"+tmpname+"」をコピーして「"+text+"」シートを挿入・Activeにしました!")
    }else{
      //Noのときの処理内容をメッセージで掲載
      Browser.msgBox("新規シートの挿入はしませんでした。")
    }
//ーーーーーここまでーーーーー
}

insertSheet(sheetName, options)のパラメーター

名前タイプ説明
sheetNameString新しいシートの名前。
optionsObjectオプションのJavaScript高度な引数。
insertSheet(sheetName, options)のパラメーター

insertSheet(sheetName, options)の高度なパラメーター

名前タイプ説明
templateSheetテンプレートシートオブジェクトのすべてのデータが新しいシートにコピーされます。シートテンプレートは、Spreadsheetオブジェクトのシートの1つである必要があります。
insertSheet(sheetName, options)の高度なパラメーター

insertSheet(sheetName, options)の戻り値

Sheet—新しいシート。

スプレッドシートに名前とオプションを指定した新規シートを挿入するまとめ

GAS×スプレッドシートに名前とオプションを指定した新規シートを挿入するならinsertSheet(sheetName, options)メソッドを利用しましょう。

関連記事:【GAS】スプレッドシートに名前とインデックスを指定した新規シートを挿入する

関連記事:【GAS】スプレッドシートで指定した名前で新規シートを作成する

関連記事:【GAS】スプレッドシートのグリッド線を非表示にする

関連記事:【GAS】スプレッドシートのシート名を変更する

関連記事:【GAS】スプレッドシートをコピーして新規シートを作成する

関連記事:【GAS】スプレッドシートのアクティブシートを削除する

関連記事:【GAS】スプレッドシートで現在アクティブなシートを返す

関連記事:【GAS】スプレッドシートで名前・行・列数を指定して新規シートする

関連記事:【GAS】スプレッドシートのアクティブシートの名前を取得する

関連記事:【GAS】スプレッドシートでアクティブなシートを返す

関連記事:【GAS】スプレッドシートでアクティブなシートを取得する

-シートを操作する