ワークシートの追加

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

利用するメソッド

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

getWorksheetの型定義

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

引数に名前を指定し、返り値として作成されたワークシートのオブジェクトが返却されます。

サンプルコード

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

getWorksheetを使ったサンプル

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

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

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

ヒント

すでに同じ名前のワークシートが存在していた場合に備えて、重複チェックを行っています。