OfficeScript | シートの取得

こんにちは。ふらです。今日はOfficeScriptのシート取得についてお話していきたいと思います。

シート取得について

OfficeScriptで何かコードを記述する際には、ほとんどの場合どのシートに対して作業するのかを指定する必要があります。シートを指定して変数に格納するには様々なメソッドがありますので、一緒に見て行きましょう。今回ご紹介するコードはこちらになります。

function main(workbook: ExcelScript.Workbook) {

    //アクティブシートを取得
    let sh1 = workbook.getActiveWorksheet();
    console.log(sh1.getName())

    //シート名を取得
    let sh2 = workbook.getWorksheet("Sheet2");
    console.log(sh2.getName())

    //3番目のシートを取得
    let sh3 = workbook.getWorksheets()[2];
    console.log(sh3.getName())

    //最初のワークシート取得
    let first_sh = workbook.getFirstWorksheet();
    console.log(first_sh.getName())

    //最後のワークシート取得
    let last_sh = workbook.getLastWorksheet();
    console.log(last_sh.getName())

    //次のシートを取得
    let next_sh = workbook.getActiveWorksheet().getNext();
    console.log(next_sh.getName())

    //前のシートを取得
    let previous_sh = workbook.getWorksheet("Sheet2").getPrevious();
    console.log(previous_sh.getName())

}

アクティブシートの取得について

ワークシートが1つしかない場合は、アクティブなシートに作業することになるので、このコードが使えると思います。また、ボタンを配置したシートでのみ作業する場合も使えると思います。

//アクティブシートを取得
let sh1 = workbook.getActiveWorksheet();
console.log(sh1.getName())

シート名でシートを取得する

ワークシートの名前でシートを指定して変数に格納します。一番使い易いシートを取得する変数だと思います。

//シート名を取得
let sh2 = workbook.getWorksheet("Sheet2");
console.log(sh2.getName())

シートを番号で指定して取得する

シートをシートの並び順の番号で取得する。一番左のシートが[0]、二番目のシートが[1]の指定となる。

//3番目のシートを取得
let sh3 = workbook.getWorksheets()[2];
console.log(sh3.getName())

最初のワークシートを取得する

1番最初（1番左側）のワークシートを取得するコードです。

//最初のワークシート取得
let first_sh = workbook.getFirstWorksheet();
console.log(first_sh.getName())

最後のワークシートを取得する

1番最後（1番右側）のワークシートを取得するコードです。

//最後のワークシート取得
let last_sh = workbook.getLastWorksheet();
console.log(last_sh.getName())

次のワークシートを取得する

アクティブシートの右側のシートを取得する。いつか使うかも？

//次のシートを取得
let next_sh = workbook.getActiveWorksheet().getNext();
console.log(next_sh.getName())

前のワークシートを取得する

アクティブシートの左側のシートを取得する。いつか使うかも？

//前のシートを取得
let previous_sh = workbook.getWorksheet("Sheet2").getPrevious();
console.log(previous_sh.getName())