Class: RubyOSBXL::Range

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

Overview

ワークシートのセル範囲を扱うクラスです。

Instance Method Summary collapse

Instance Method Details

#clearAllFormat ⇒ void

セル範囲の書式すべてをワークシートの初期値に戻します。

#clearContent ⇒ void

セル範囲の値をクリアします。

#clearDataTable ⇒ void

Note:

データテーブルを消去します。Rangeのセル範囲の中に、データテーブルの(データ部=TABLE関数)が入っていれば、消去します。

データテーブルのクリアを行います。

#clearNumberFormat ⇒ void

セル範囲のセル書式をクリアします。

#getAddress ⇒ String

セル範囲(A1C1文字列形式)の取得を行います。

Returns:

  • (String) —

    セル範囲(A1C1文字列形式)

#getAlignment ⇒ RubyOSBXL::Alignment

セル配置クラスの取得を行います。

Returns:

#getBorders ⇒ RubyOSBXL::Borders

枠線一括クラスの取得を行います。

Returns:

#getCharacters(start) ⇒ RubyOSBXL::Characters #getCharacters(start, length) ⇒ RubyOSBXL::Characters

Overloads:

  • #getCharacters(start) ⇒ RubyOSBXL::Characters

    文字列クラスの取得を行います。

    Parameters:

    • start (Integer) —

      開始文字位置 (1から始まります)

    Returns:

  • #getCharacters(start, length) ⇒ RubyOSBXL::Characters

    文字列クラスの取得を行います。

    Parameters:

    • start (Integer) —

      開始文字位置 (1から始まります)

    • length (Integer) —

      文字数 (1から始まります)

    Returns:

#getFill ⇒ RubyOSBXL::Fill

塗りつぶしクラスの取得を行います。

Returns:

#getFont ⇒ RubyOSBXL::Font

フォントクラスの取得を行います。

Returns:

#getFormula ⇒ Hash<String, String>

セル範囲の関数を取得します。

Returns:

  • (Hash<String, String>) —

    Map<セル範囲(A1), 関数>

#getNumberFormat ⇒ Hash<String, String>

セル配置のセル書式を取得します。

Returns:

  • (Hash<String, String>) —

    Map<セル範囲(A1), セル書式>

#getPhonetics ⇒ RubyOSBXL::Phonetics

フリガナクラスの取得を行います。

Returns:

#getProtection ⇒ RubyOSBXL::Protection

セル保護クラスの取得を行います。

Returns:

#getTotalColumnWidth ⇒ Numeric

Note:

セル範囲の列に収まる文字数を設定します。文字数の単位は、現在のフォントの0~9の文字の中で一番横幅が長い文字となります(Excel同様です)。

セル範囲の列に収まる文字数の取得を行います。

Returns:

  • (Numeric) —

    セル範囲の列に収まる文字数

#getTotalRowHeight ⇒ Numeric

Note:

セル範囲のポイント(pt)数を取得します。

セル範囲の高さの取得を行います。

Returns:

  • (Numeric) —

    セル範囲の高さ

#getTotalWidth ⇒ Numeric

Note:

セル範囲のピクセル数を取得します。OSBXLでは、DPIを96DPIとした計算値を取得します。

セル範囲の幅の取得を行います。

Returns:

  • (Numeric) —

    セル範囲のピクセル数

#getValue ⇒ Hash<String, String>

セル範囲の値を取得します。

Returns:

  • (Hash<String, String>) —

    Map<セル範囲(A1), 値>

#merge(mergeEachRow = false) ⇒ void

セル範囲を結合します。

Parameters:

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

    true: 行単位に分割して結合 false: セル範囲全体を結合

#replaceValue(oldType, oldValue, newType, newValue) ⇒ void

Note:

値の置換を行います。関数による出力値が、対象に含まれていた場合、値の置換を行った上、関数を削除します。

セル範囲の値の置換を行います。

Parameters:

  • oldType (RubyOSBXL::Enums::XlReplaceCellType) —

    検索対象のセルのセルタイプ

  • oldValue (String) —

    検索対象のセルのセル値

  • newType (RubyOSBXL::Enums::XlReplaceCellType) —

    更新値のセルタイプ(ReplaceCellTypeErrorは設定できません)

  • newValue (String) —

    更新値 日付/時刻型の場合も、文字列で入力します(例:2023/01/01)

#setBooleanValue(value, forceString = false, numberFormat = "") ⇒ void

セル配置の値を設定します(論理値)。

Parameters:

  • value (bool) —

    値 true: TRUE false: FALSE

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

    true: 強制的に文字列と扱う false: 通常

  • numberFormat (String) (defaults to: "") —

    セルの書式 空文字の場合は、設定しません。

#setBuiltinStyle(builtinNumber) ⇒ void

セル範囲にExcelビルトイン(組み込み)のセルスタイルを適用します。

Parameters:

#setCustomStyle(customStyleName) ⇒ void

セル範囲にカスタムセルスタイルの適用を行います。

Parameters:

  • customStyleName (String) —

    カスタムセルスタイル名

#setDataTable(rowA1, colA1) ⇒ void

Note:

データテーブルの範囲は、Rangeのセル範囲となります。

Note:

rowA1およびcolA1の両方に値を設定すると、複方向(行、列)のデータテーブルとなり、片方に値を設定すると、単方向(行または列)となります。

Note:

複方向の時は、計算セルは、左上のセルとなります。

Note:

単方向の時は、Rangeのセル範囲は、２行または、２列である必要があります。

Note:

データーテーブルの向きが行の時は２列目の先頭セルに計算式がある必要があり、列の時は、２行目の先頭セルに計算式がある必要があります。

データテーブルの設定を行います。

Parameters:

  • rowA1 (String) —

    単方向データテーブルの向きが行の時は、空文字を設定します。

  • colA1 (String) —

    方向データテーブルの向きが列の時は、空文字を設定します。

#setDateStringValue(value, forceString = false, numberFormat = "") ⇒ void

セル配置の値を設定します(日付/時刻設定メソッド(文字列から入力))。

Parameters:

  • value (String) —

    値

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

    true: 強制的に文字列と扱う false: 通常

  • numberFormat (String) (defaults to: "") —

    セルの書式 空文字の場合は、設定しません。

#setDateValue(value, forceString = false, numberFormat = "") ⇒ void

セル配置の値を設定します(日付時刻オブジェクト)。

Parameters:

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

    値

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

    true: 強制的に文字列と扱う false: 通常

  • numberFormat (String) (defaults to: "") —

    セルの書式 空文字の場合は、設定しません。

#setFormula(formula, isArray = false, setAllCell = false) ⇒ void

Note:

ARRAY数式の場合、setAllCellは無視されます。

Note:

ExcelのSpill機能をサポートしています。そのため、1セルに対して、複数セルの返却値が返されることがあります。

Note:

Excel同様に、セル範囲は、相対参照、絶対参照($つき)を設定可能です。

数式の設定を行います。

Parameters:

  • formula (String) —

    数式

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

    true: Array数式としてセル範囲全体が入力対象 false: 通常数式

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

    false: 対象セルのTopLeftセル(先頭セル)だけformulaを設定する true: 全セルに数式を設定する

#setNumberFormat(numberFormat) ⇒ void

セル配置のセル書式を設定します。

Parameters:

  • numberFormat (String) —

    セル書式

#setNumberValue(value, forceString = false, numberFormat = "") ⇒ void

セル配置の値を設定します(数値)。

Parameters:

  • value (Numeric) —

    値

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

    true: 強制的に文字列と扱う false: 通常

  • numberFormat (String) (defaults to: "") —

    セルの書式 空文字の場合は、設定しません。

#setValue(value, forceString = false, numberFormat = "") ⇒ void

セル配置の値を設定します(汎用)。

Parameters:

  • value (String) —

    値

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

    true: 強制的に文字列と扱う false: 通常

  • numberFormat (String) (defaults to: "") —

    セルの書式 空文字の場合は、設定しません。

#unMerge ⇒ void

結合の解除を行います。