ワークシートの追加

ここではオフィススクリプトからワークシートを追加する方法を、サンプルコードと併せて解説します。

利用するメソッド

Workbookオブジェクトに用意されている、addWorksheetメソッドを使用します。

/**
 * @param name 追加するシート名(省略可能)
 * @return 追加されたワークシート
 */
ExcelScript.Workbook.addWorksheet(name?: string): Worksheet;

引数に名前を指定し、返り値として作成されたワークシートのオブジェクトが返却されます。追加したワークシートは、既存のワークシートの末尾に配置されます。

引数を省略した場合は、Excel によって自動的にシート名が決定されます。

追加したワークシートを表示したい場合は、返り値のワークシートに対してactivateメソッドを実行します。

サンプルコード

シート名を指定し、ワークシートを作成するサンプルです。

function main(workbook: ExcelScript.Workbook) {
  /** 追加するシート名 */
  const sheetname = 'created-by-office-script';

  if (workbook.getWorksheet(sheetname)) {
    throw `${sheetname}という名前のワークシートはすでに存在しています`;
  }

  /** 作成されたワークシート */
  const created = workbook.addWorksheet(sheetname);
}