Excelのワークブックを取り扱うクラスです。

ワークシートの生成や削除や位置移動、読み込みや保存を行います。 また、カスタムスタイルやカスタムテーブルスタイルの作成、削除も可能です。

openWorkBook等で取得されたクラスは、不要となった時点でcloseメソッドを呼び、ワークブックを閉じる必要があります。

Methods

  • カスタムセルスタイルを追加します。

    Parameters

    • styleName: string

      セルスタイル名

    • customStyleObject: CustomStyleObject

      セルスタイルオブジェクト

    Returns void

  • カスタムテーブルスタイルを追加します。派生元テーブルスタイルが設定された場合は、既存のスタイルからのコピー&上書きして追加します。

    1. CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。
    2. 設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

    Parameters

    • tableStyleName: string

      テーブルスタイル名

    • customTableStyleObject: CustomTableStyleObject

      テーブルスタイルオブジェクト

    • Optional defaultStyle: XlDefaultTableStyle

      派生元テーブルスタイル

    Returns void

  • ワークシートの参照先として用いる外部ワークブックを追加します。

    1. 外部ブックを参照する関数や値を新規に入力する前に、本メソッドで外部ワークブックを予め登録しておく必要があります。

    Parameters

    • path: string

      外部ワークシートのパス

    Returns number

    追加された外部ブックID 1から始まります。

    Throws

    IOError

  • カスタムテーブルスタイルを追加します(ピボットテーブル)。派生元ピボットテーブルスタイルが設定された場合は、既存のスタイルからのコピー&上書きとなります。

    1. CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。
    2. 設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

    Parameters

    • tableStyleName: string

      ピボットテーブルスタイル名

    • customTableStyleObject: CustomTableStyleObject

      テーブルスタイルオブジェクト

    • Optional defaultPivotStyle: XlPivotDefaultTableStyle

      派生元ピボットテーブルスタイル

    Returns void

  • ワークシートを追加します。

    1. `position`の先頭は1です。
    2. `position`の前にシートを挿入します(-1の場合は最後尾になります)。

    Parameters

    • sheetName: string

      シート名

    • position: number = -1

      挿入位置

    Returns WorkSheet

    追加したワークシートクラス

  • ワークブックを閉じます。

    1. このメソッドは、必ず呼ぶ必要があります(ワークブックが不必要になった時点で)。

    Returns void

  • カスタムセルスタイルを削除します。

    Parameters

    • styleName: string

      セルスタイル名

    Returns void

  • カスタムテーブルスタイルを削除します。

    1. テーブルスタイル、ピボットテーブルスタイル両方とも削除可能です。

    Parameters

    • tableStyleName: string

      テーブルスタイル名または、ピボットテーブルスタイル名

    Returns void

  • ワークシートを削除します。

    Parameters

    • sheetName: string

      シート名

    Returns void

  • ワークブックのファイルパスを取得します。

    Returns string

    ファイルの絶対パス

  • カスタムセルスタイルを取得します。

    Parameters

    • styleName: string

      セルスタイル名

    Returns CustomStyleObject

    セルスタイルオブジェクト

  • カスタムテーブルスタイルを取得します。

    1. テーブルスタイルも、ピボットテーブルスタイルも取得可能です。

    Parameters

    • tableStyleName: string

      テーブルスタイル名または、ピボットテーブルスタイル名

    Returns CustomTableStyleObject

    テーブルスタイルオブジェクト

  • 外部ワークブック一覧を取得します。

    Returns Map<number, string>

    Map<externalId(外部ワークブックID:1から始まります),外部ワークブックのファイルパス>

  • 名前付き範囲クラスを取得します。

    Returns Names

    名前付き範囲クラス

  • ワークシート数を取得します。

    Returns number

    ワークシート数

  • ワークシートのシート番号を取得します。

    Parameters

    • sheetName: string

      シート名

    Returns number

    シート番号 (先頭シートを1とします)

  • Excelの日付1904年形式であるかどうかを取得します。

    Returns boolean

    true: 1904年形式 false: 既定形式

  • ワークシートを移動します。

    Parameters

    • sheetName: string

      シート名

    • position: number

      移動後のポジション (先頭シートを1とします)

    Returns void

  • ワークシートを開きます。

    Parameters

    • sheetName: string

      シート名

    Returns WorkSheet

    読み込んだワークシートクラス

  • ワークブックを同一ファイルに保存します。パスワードが設定された場合は、パスワード付きで同一ファイルに保存します。

    1. 保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

    Parameters

    • Optional passWord: string

      _optional パスワード

    Returns void

  • ワークブックを別ファイルに保存します。パスワードが設定された場合は、パスワード付きで別ファイルに保存します。

    1. 保存可能なファイル形式は、.xlsx,.xlsm,.xltx,.xltmです。

    Parameters

    • savePath: string

      保存Excelの絶対パス

    • Optional passWord: string

      _optional パスワード。読み込んだパスワード付きワークブックを空文字で設定すると、パスワードなしとなります。

    Returns void

    Throws

    IOError

  • ワークブックのファイル属性として所属組織(Company)を設定します。

    Parameters

    • company: string

      所属組織

    Returns void

  • ワークブックのファイル属性としてドキュメント作成者を設定します。

    Parameters

    • author: string

      ドキュメント作成者

    Returns void

  • ワークブックのファイル属性としてドキュメントの最終更新者を設定します。

    Parameters

    • author: string

      ドキュメントの最終更新者

    Returns void

  • ワークブックのファイル属性として管理者(マネージャー)を設定します。

    Parameters

    • manager: string

      管理者(マネージャー)

    Returns void

  • ワークシートの参照先として用いる外部ワークブックを更新します(参照先のデータを再度取り込みます)。

    1. `externalId`は、getExternalWorkBookPathメソッドで確認できます。
    2. シートの外部ワークシートは、取り込まれた(キャッシュされた)データを元に計算されます。
    3. (更新された)外部ワークシートの最新データを取得するには、本メソッドを呼ぶ必要があります。

    Parameters

    • externalId: number

      外部ワークシートID 1から始まります。

    Returns void

   Copyright © 2023. OSB-OFFICE.Inc, All rights reserved.   Generated using TypeDoc