Class: RubyOSBXL::WorkBook

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosbxl.rb

Overview

Note:

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

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

Instance Method Summary collapse

Instance Method Details

#addCustomStyle(styleName, customStyleObject) ⇒ void #addCustomStyle(styleName, customStyleObject, builtinNumber) ⇒ void

Overloads:

  • #addCustomStyle(styleName, customStyleObject) ⇒ void

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

    Parameters:

  • #addCustomStyle(styleName, customStyleObject, builtinNumber) ⇒ void

    カスタムセルスタイルを既存のスタイルからコピー＆上書きして追加します。

    Parameters:

#addCustomTableStyle(tableStyleName, customStyleObject) ⇒ void #addCustomTableStyle(tableStyleName, customStyleObject, defaultStyle) ⇒ void

Overloads:

  • #addCustomTableStyle(tableStyleName, customStyleObject) ⇒ void
    Note:

    設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

    カスタムテーブルスタイルを追加します。

    Parameters:

  • #addCustomTableStyle(tableStyleName, customStyleObject, defaultStyle) ⇒ void
    Note:

    設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

    カスタムテーブルスタイルを既存のスタイルからコピー＆上書きして追加します。

    Parameters:

#addExternalWorkBook(path) ⇒ Integer

Note:

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

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

Parameters:

  • path (String) —

    外部ワークシートのパス

Returns:

  • (Integer) —

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

#addPivotCustomTableStyle(tableStyleName, customTableStyleObject) ⇒ void #addPivotCustomTableStyle(tableStyleName, customTableStyleObject, defaultPivotStyle) ⇒ void

Overloads:

  • #addPivotCustomTableStyle(tableStyleName, customTableStyleObject) ⇒ void
    Note:

    CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。

    Note:

    設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

    カスタムテーブルスタイルを追加します(ピボットテーブル)。

    Parameters:

  • #addPivotCustomTableStyle(tableStyleName, customTableStyleObject, defaultPivotStyle) ⇒ void
    Note:

    CustomTableStyleObjectクラスは、ピボットテーブルと共用して使用されています。

    Note:

    設定可能項目は、テーブルスタイルとピボットテーブルスタイルで違います。

    カスタムテーブルスタイルを既存のスタイルからコピー＆上書きして追加します(ピボットテーブル)。

    Parameters:

#addWorkSheet(sheetName, position = -1)) ⇒ RubyOSBXL::WorkSheet

Note:

positionの先頭は1です。

Note:

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

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

Parameters:

  • sheetName (String) —

    シート名

  • position (Integer) (defaults to: -1)) —

    挿入位置

Returns:

#close ⇒ void

Note:

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

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

#deleteCustomStyle(styleName) ⇒ void

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

Parameters:

  • styleName (String) —

    セルスタイル名

#deleteCustomTableStyle(tableStyleName) ⇒ void

Note:

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

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

Parameters:

  • tableStyleName (String) —

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

#deleteWorkSheet(sheetName) ⇒ void

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

Parameters:

  • sheetName (String) —

    シート名

#getBookPath ⇒ String

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

Returns:

  • (String) —

    ファイルの絶対パス

#getCustomStyle(styleName) ⇒ RubyOSBXL::Dto::CustomStyleObject

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

Parameters:

  • styleName (String) —

    セルスタイル名

Returns:

#getCustomTableStyle(tableStyleName) ⇒ RubyOSBXL::Dto::CustomTableStyleObject

Note:

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

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

Parameters:

  • tableStyleName (String) —

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

Returns:

#getExternalWorkBookPath ⇒ Hash<Integer, String>

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

Returns:

  • (Hash<Integer, String>) —

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

#getNames ⇒ RubyOSBXL::Names

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

Returns:

#getSheetCount ⇒ Integer

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

Returns:

  • (Integer) —

    ワークシート数

#getSheetNumber(sheetName) ⇒ Integer

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

Parameters:

  • sheetName (String) —

    シート名

Returns:

  • (Integer) —

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

#isDate1904 ⇒ bool

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

Returns:

  • (bool) —

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

#moveSheet(sheetName, position) ⇒ void

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

Parameters:

  • sheetName (String) —

    シート名

  • position (Integer) —

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

#openWorkSheet(sheetName) ⇒ RubyOSBXL::WorkSheet

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

Parameters:

  • sheetName (String) —

    シート名

Returns:

#save ⇒ void #save(passWord) ⇒ void

Overloads:

  • #save ⇒ void

    ワークブックを同一ファイルに保存します。保存可能なファイル形式は、.xlsx, .xlsm, .xltx, .xltmです。

  • #save(passWord) ⇒ void

    ワークブックを同一ファイルにパスワード付きで保存します。保存可能なファイル形式は、.xlsx, .xlsm, .xltx, .xltmです。

    Parameters:

    • passWord (String) —

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

#saveAs(savePath) ⇒ void #saveAs(savePath, passWord) ⇒ void

Overloads:

  • #saveAs(savePath) ⇒ void

    ワークブックを保存します。保存可能なファイル形式は、.xlsx, .xlsm, .xltx, .xltmです。

    Parameters:

    • savePath (String) —

      保存Excelのパス

  • #saveAs(savePath, passWord) ⇒ void

    ワークブックをパスワード付きで保存します。保存可能なファイル形式は、.xlsx, .xlsm, .xltx, .xltmです。

    Parameters:

    • savePath (String) —

      保存Excelのパス

    • passWord (String) —

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

#setCompanyName(company) ⇒ void

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

Parameters:

  • company (String) —

    所属組織

#setCreateAuthor(author) ⇒ void

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

Parameters:

  • author (String) —

    ドキュメント作成者

#setLastAuthor(author) ⇒ void

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

Parameters:

  • author (String) —

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

#setManagerName(manager) ⇒ void

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

Parameters:

  • manager (String) —

    管理者(マネージャー)

#updateExternalWorkBook(externalId) ⇒ void

Note:

externalIdは、getExternalWorkBookPathメソッドで確認できます。

Note:

シートの外部ワークシートは、取り込まれた(キャッシュされた)データを元に計算されます。

Note:

(更新された)外部ワークシートの最新データを取得するには、本メソッドを呼ぶ必要があります。

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

Parameters:

  • externalId (Integer) —

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