Home » Googleスプレッドシートの使い方 » Google Apps Scriptでシートの枚数を取得する

Google Apps Scriptでシートの枚数を取得する

対象：Googleスプレッドシート & Google Apps Script

GAS（Google Apps Script）スクリプトを作成しているときに、Googleスプレッドシートに含まれるシートの枚数を取得する必要が出てきました。

その際、Excel VBA（Visual Basic for Applications）とは、考え方が随分違うなと感じましたので、記事にしておきます。

［スポンサードリンク］

VBAではコレクションオブジェクトに必ずCountプロパティがある

Excel VBAの場合、ワークシートもグラフシートも含むすべてのシートの枚数を取得するには、SheetsコレクションオブジェクトのCountプロパティを利用します。

ワークシートだけの枚数ならば、WorksheetsコレクションオブジェクトのCountプロパティで取得できます。

Sheetsコレクション・Worksheetsコレクションに限らず、VBAでは、そのコレクションに含まれる単一オブジェクトの数を返すCountプロパティが、コレクションオブジェクトには必ず用意されています。

VBAのオブジェクトモデルの考え方に慣れている私は、GASでもついつい同じように考えてしまいましたが、GASの場合はまったく違う考え方をする必要があり、以下のようなスクリプトでシートの枚数を取得できます。

function sample_getNumSheets(){

　var bk = SpreadsheetApp.getActiveSpreadsheet();
　var sh_cnt = bk.getNumSheets();

　Browser.msgBox(sh_cnt);

}

Excel VBAのWorkbookオブジェクト的な立場にあるSpreadsheetクラスに、シートの枚数を取得するgetNumSheet()メソッドが存在しています。

Excel VBA的な考え方をするなら、以下のようなコードでしょうか。

function sample_getSheets_length(){

　var bk = SpreadsheetApp.getActiveSpreadsheet();
　var sh_cnt = bk.getSheets().length;

　Browser.msgBox(sh_cnt);

}

SpreadsheetクラスのgetSheets()メソッドを使ってSheetオブジェクトを配列の形で取得して、配列の要素数を取得するJavaScriptのArray.lengthプロパティを使って、Sheetの数を取得しています。

［スポンサードリンク］

Home » Googleスプレッドシートの使い方 » Google Apps Scriptでシートの枚数を取得する

『インストラクターのネタ帳』では、2003年10月から平日のほぼ毎日、Microsoft Officeの使い方などを紹介し続けています。
Pythonの外部ライブラリOpenPyXL（オープンパイエクセル）の入門書を、Excel VBAユーザーに向けに書きました↓↓

Pythonの文字列フォーマットの基本をキンドル本としてまとめました↓↓

小数とPythonのdecimalモジュールの基本をキンドル本としてまとめました↓↓

図形を操作するExcel VBAの基本を解説したキンドル本を出しました↓↓

グラフを操作するExcel VBAの基本を解説したキンドル本です↓↓

『インストラクターのネタ帳』を運営する伊藤潔人が、初めて書かせていただいた書籍です↓↓

PowerPoint VBA本は、実はオブジェクトブラウザーの使い方を徹底的に解説した本です↓↓

Excel VBAユーザーを対象とした、Word VBAの入門書をキンドル本として出しました↓↓

日経BP社から出版された、Excel VBAユーザー向けのPython超入門書です↓↓

上記の『Excel VBAユーザーのためのPythonプログラミング』の元になったキンドル本です↓↓

数式を使った条件付き書式設定が苦手な方に向けたKindle本を書きました↓↓

3年前(2021年4月)の
人気記事

「Googleスプレッドシートの使い方」の記事一覧