Excel Officeスクリプト ブック内の全シートを取得

2023年4月10日

English version.

ブック内の全シートを取得する方法を紹介します。

全シートに対してシート名の取得や何らかの操作を行いたい場合に有効です。

使い方

次の構文で行います。(赤字は可変部分

配列変数 = workbook.getWorksheets();

取得した配列変数に対して何らかの操作を行います。

ブック内のシート数を取得する例

次のコード例では.lengthで件数(ブック内のシート)である3を出力しています。

function main(workbook: ExcelScript.Workbook) {
	let sheets = workbook.getWorksheets();
  
	console.log(sheets.length);
}

全シートのシート名を表示する例

function main(workbook: ExcelScript.Workbook) {
	let sheets = workbook.getWorksheets();
  
	for (let sheet of sheets){
		console.log(sheet.getName());
	}
}

全シートのシート名を変更する例

シート名が重複しないように設定する必要があります。

function main(workbook: ExcelScript.Workbook) {
	let sheets = workbook.getWorksheets();
  
	for(let i=0; i<sheets.length; i++){
		sheets[i].setName("シート_" + (i+1).toString());
	}
}

このスクリプトを実行するとシート名が、

「シート_1」「シート_2」 「シート_3」に変更されます。

全シートのタブ色を変更する例

function main(workbook: ExcelScript.Workbook) {
	let sheets = workbook.getWorksheets();
  
	for(let i=0; i<sheets.length; i++){
		sheets[i].setTabColor("green");
	}
}

このスクリプトを実行すると全シートのタブ色が緑になります。

Office スクリプトを効果的に習得したい方へ

当サイトの情報を電子書籍用に読み易く整理したコンテンツを

買い切り700円またはKindle Unlimited (読み放題) で提供中です。

体系的に学びたい方は是非ご検討ください。

アップデートなどの更新事項があれば随時反映しています。

なお購入後に最新版をダウンロードするには

Amazonへの問い合わせが必要です。

関連記事

Excel Office スクリプトの記事一覧