[Office Scripts]シートの取得方法まとめ

今回は、Office Scriptsの基本となるシートの取得方法をまとめてみました。

アクティブシートを取得

(Workbook).getActiveWorksheetメソッドで、現在作業中のアクティブシートを取得できます。

	//アクティブシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let sheet = workbook.getActiveWorksheet();
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw アクティブシートを取得.ts hosted with by GitHub

シート名を指定してシートを取得

(Workbook).getWorksheetメソッドでシートの名前、もしくはIDを指定してシートを取得できます。

	//シート名を指定してシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let sheet = workbook.getWorksheet("Sheet1");
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw シート名を指定してシートを取得.ts hosted with by GitHub

ただし、ブックに存在しないシートを取得しようとすると、undefinedが返ってきます。

	//シート名を指定してシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let sheet = workbook.getWorksheet("Sheet1");
	if (sheet !== void 0) { //存在しないシートの場合はundefinedが返ってくる
	sheet.getRange("B2").select(); //セルB2を選択
	}
	}

view raw シート名を指定してシートを取得(2).ts hosted with by GitHub

最初のシートを取得

(Workbook).getFirstWorksheetメソッドで最初のシートを取得できます。メソッドの引数にtrueを指定することで、表示されているシートのみを対象とし、非表示のシートはスキップします。

	//最初のシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let sheet = workbook.getFirstWorksheet(); //メソッドの引数にtrueを指定すると非表示のシートをスキップ
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw 最初のシートを取得.ts hosted with by GitHub

最後のシートを取得

(Workbook).getLastWorksheetメソッドで最後のシートを取得できます。メソッドの引数にtrueを指定することで、表示されているシートのみを対象とし、非表示のシートはスキップします。

	//最後のシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let sheet = workbook.getLastWorksheet(); //メソッドの引数にtrueを指定すると非表示のシートをスキップ
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw 最後のシートを取得.ts hosted with by GitHub

次のシートを取得

(Worksheet).getNextメソッドで次のシートを取得できます。メソッドの引数にtrueを指定することで、表示されているシートのみを対象とし、非表示のシートはスキップします。

	//次のシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let currentSheet = workbook.getActiveWorksheet();
	let sheet = currentSheet.getNext(); //メソッドの引数にtrueを指定すると非表示のシートをスキップ
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw 次のシートを取得.ts hosted with by GitHub

前のシートを取得

(Worksheet).getPreviousメソッドで前のシートを取得できます。メソッドの引数にtrueを指定することで、表示されているシートのみを対象とし、非表示のシートはスキップします。

	//前のシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let currentSheet = workbook.getActiveWorksheet();
	let sheet = currentSheet.getPrevious(); //メソッドの引数にtrueを指定すると非表示のシートをスキップ
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw 前のシートを取得.ts hosted with by GitHub

n番目のシートを取得

(Workbook).getWorksheetsメソッドでWorksheetオブジェクトを格納する配列を取得し、n番目のシートを取得できます。

	//n番目のシートを取得
	function main(workbook: ExcelScript.Workbook) {
	let sheet = workbook.getWorksheets()[1]; //2番目のシートを取得
	sheet.getRange("B2").select(); //セルB2を選択
	}

view raw n番目のシートを取得.ts hosted with by GitHub

関連記事

2020.05.03

Office Scripts(Office スクリプト)の記事まとめ

当ブログの「Office Scripts」関連の記事をまとめてみました。 Office Scriptsの基本 セル操作 シート操作 図形・画像操作 テーブル操作 グラフ操作 Power Automate連携 その他 O...

• 投稿者: きぬあさ
• Office Scripts
• コメント: 0

関連記事

1. 

   Office Scripts

   Office Scriptsの要件と制限

   いまさらですが、Office Scriptsのシステム要件や制限事項に…

2. 

   Office Scripts

   [Office Scripts]ワークシート関数を実行しようとして失敗した話

   下記記事でも紹介していますが、Office アドインではワークシート関…

3. 

   Office Scripts

   [Office Scripts]指定した列の最終セルを取得する方法

   2021/7/5 追記：さらに簡単に指定した列の最終セルを取得する…

4. 

   Office Scripts

   [Office Scripts]指定した列の最終セルを取得する方法(2)

   Office スクリプトで指定した列の最終セルを取得する方法として、こ…

5. 

   Office アドイン

   Office Scriptsってどんな機能？

   昨年の11月、Ignite 2019で発表されたオンライン版Excel…

6. 

   Office Scripts

   [Office Scripts]押さえておきたい基本的なポイント

   Office Scriptsでコードを書くにあたり、ハマりそうなポイン…

• コメント (0)

• トラックバックは利用できません。