Class: RubyOSBXL::App

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

Overview

osbxlのアプリケーション起動クラスです。Excelファイルの新規作成、既存ファイルの読み込みを行います。各種ユーティリティも備え持ちます。

Instance Method Summary collapse

Constructor Details

#initialize ⇒ void

コンストラクタ

インスタンスを作成します。

Instance Method Details

#convertFromColumnNumber(colNumber, absDisplay = false) ⇒ String

Note:

列番号は1から始まります。(A列が、1です)

列の数値表記をA1表記に変換します。

Parameters:

  • colNumber (Integer) —

    列番号

  • absDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

Returns:

  • (String) —

    A1表記

#convertFromRowColNumber(rowNumber, colNumber, absRowDisplay = false, absColDisplay = false) ⇒ String

Note:

列番号、行番号は、1から始まります。((1, 1)は、A1となります)

セルの数値表記をA1C1表記にに変換します。

Parameters:

  • rowNumber (Integer) —

    行番号

  • colNumber (Integer) —

    列番号

  • absRowDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

  • absColDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

Returns:

  • (String) —

    A1表記

#convertFromRowColNumber2(startRowNumber, startColNumber, endRowNumber, endColNumber, absStartRowDisplay = false, absStartColDisplay = false, absEndRowDisplay = false, absEndColDisplay = false) ⇒ String

Note:

列番号、行番号は、1から始まります。((1, 1)は、A1となります)

セル範囲の数値表記をA1C1表記にに変換します。

Parameters:

  • startRowNumber (Integer) —

    先頭行番号

  • startColNumber (Integer) —

    先頭列番号

  • endRowNumber (Integer) —

    末尾行番号

  • endColNumber (Integer) —

    末尾列番号

  • absStartRowDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

  • absStartColDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

  • absEndColDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

  • absEndRowDisplay (bool) (defaults to: false) —

    trueの場合、$付き表記(セルの絶対参照)で取得します。

Returns:

  • (String) —

    A1C1表記

#convertToColumnNumber(a1) ⇒ Integer

Note:

返却値は、1から始まります。

列のA1表記を数値型表記に変換します。

Parameters:

  • a1 (String) —

    A1表記

Returns:

  • (Integer) —

    列の数値変換値

#createWorkBook(bookPath, defalutFont = RubyOSBXL::Enums::XlFont::WORKBOOK_DEFAULT, defaultFontSize = 11.0) ⇒ RubyOSBXL::WorkBook

Note:

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

Note:

ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

ワークブックを作成します。

Parameters:

  • bookPath (String) —

    ワークブックのファイルパス

  • defalutFont (RubyOSBXL::Enums::XlFont) (defaults to: RubyOSBXL::Enums::XlFont::WORKBOOK_DEFAULT) —

    フォント列挙体

  • defaultFontSize (Numeric) (defaults to: 11.0) —

    フォントサイズ

Returns:

#getNumericValue(dateTimeObject, is1904 = false) ⇒ Numeric

日付時刻型オブジェクトからExcel内部でもっている数値の値(シリアル値)を取得します。

Parameters:

  • dateTimeObject (RubyOSBXL::Dto::DateTimeObject) —

    変換元日付時刻型オブジェクト 最小値は、is1904メソッドに依存した値となり、最大値は、9999/12/31となります。

  • is1904 (bool) (defaults to: false) —

    ワークブックの年月が1904年形式(最小値が1904/1/1)の場合、true 通常(最小値が1900/1/1)の場合: false

Returns:

  • (Numeric) —

    シリアル値

#getVersion ⇒ String

アプリケーションのバージョンを取得します。

Returns:

  • (String) —

    アプリケーションのバージョン

#openPasswordWorkBook(bookPath, passWord) ⇒ RubyOSBXL::WorkBook

Note:

読み込み可能なファイル形式は、.xlsx, .xlsm, .xltx, .xltmです。

Note:

ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

パスワード付きワークブックを開きます。

Parameters:

  • bookPath (String) —

    ワークブックのファイルパス

  • passWord (String) —

    パスワード

Returns:

#openWorkBook(bookPath) ⇒ RubyOSBXL::WorkBook

Note:

読み込み可能なファイル形式は、.xlsx, .xlsm, .xltx, .xltmです。

Note:

ワークブックは、一意性を確保するため、内部でロックされます。この処理によって、同一ワークブックの同時読込・書込はおこりません。

ワークブックを開きます。

Parameters:

  • bookPath (String) —

    ワークブックのファイルパス

Returns: