Class: RubyOSBXL::Table

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

Overview

テーブルを扱うクラスです。

Instance Method Summary collapse

Instance Method Details

#changeTableName(tableName) ⇒ void

テーブル名の変更を行います。

Parameters:

  • tableName (String) —

    テーブル名

#getAllRange ⇒ RubyOSBXL::Range

テーブルの全範囲をセル範囲クラスで取得します。

Returns:

#getAutoFilter ⇒ RubyOSBXL::AutoFilter

オートフィルタークラスの取得を行います。

Returns:

#getColumnName ⇒ Array<String>

列名の一括取得を行います。

Returns:

  • (Array<String>) —

    Array<列名>

#getDataBodyRange ⇒ RubyOSBXL::Range

テーブルのデータ部をセル範囲クラスで取得します。

Returns:

#getHeaderRowRange ⇒ RubyOSBXL::Range

テーブルのヘッダをセル範囲クラスで取得します。

Returns:

#getName ⇒ String

テーブル名の取得を行います。

Returns:

  • (String) —

    テーブル名

#getTableStyleName ⇒ String

テーブルスタイル名の取得を行います。

Returns:

  • (String) —

    テーブルスタイル名

#getTotalRowFunction(colNum) ⇒ RubyOSBXL::Enums::XlTotalsCalculation

集計行の計算方法の取得を行います。

Parameters:

  • colNum (Integer) —

    列番号(先頭=1)

Returns:

#getTotalRowLabel(colNum) ⇒ String

集計行のラベル名の取得を行います。

Parameters:

  • colNum (Integer) —

    列番号(先頭=1)

Returns:

  • (String) —

    集計行のラベル名の取得

#getTotalRowRange ⇒ RubyOSBXL::Range

テーブルの集計行をセル範囲クラスで取得します。

Returns:

#isShowAutoFilter ⇒ bool

オートフィルターの表示有無の取得を行います。

Returns:

  • (bool) —

    true: オートフィルターのテーブルスタイルが適用されている false: オートフィルターのテーブルスタイルが適用されていない

#isShowHeaders ⇒ bool

ヘッダの表示有無の取得を行います。

Returns:

  • (bool) —

    true: ヘッダが表示されている false: ヘッダが表示されていない

#isShowTableStyleColumnStripes ⇒ bool

テーブルスタイルの適用有無の取得（１行おき：列）を行います。

Returns:

  • (bool) —

    true: （１行おき：列）のテーブルスタイルが適用されている false: （１行おき：列）のテーブルスタイルが適用されていない

#isShowTableStyleFirstColumn ⇒ bool

テーブルスタイルの適用有無の取得（最初列）を行います。

Returns:

  • (bool) —

    true: 最初列のテーブルスタイルが適用されている false: 最初列のテーブルスタイルが適用されていない

#isShowTableStyleLastColumn ⇒ bool

テーブルスタイルの適用有無の取得（最終列）を行います。

Returns:

  • (bool) —

    true: 最終列のテーブルスタイルが適用されている false: 最終列のテーブルスタイルが適用されていない

#isShowTableStyleRowStripes ⇒ bool

テーブルスタイルの適用有無の取得（１行おき：行）を行います。

Returns:

  • (bool) —

    true: （１行おき：行）のテーブルスタイルが適用されている false: （１行おき：行）のテーブルスタイルが適用されていない

#isShowTotals ⇒ bool

集計行の表示有無の取得を行います。

Returns:

  • (bool) —

    true: 集計行が表示されている false: 集計行が表示されていない

#removeAutoFilter ⇒ void

オートフィルターの除去を行います。

#setBuiltinStyleName(builtinStyleName, clearFormat) ⇒ void

テーブルスタイル名の設定（ビルトイン）を行います。

Parameters:

  • builtinStyleName (RubyOSBXL::Enums::XlDefaultTableStyle) —

    ビルトインのテーブルスタイル

  • clearFormat (bool) —

    true : セルの書式を一旦クリアした後、テーブルスタイルを適用する false: 今の状態に適用する

#setColumnName(columnNames) ⇒ void

列名の一括設定を行います。

Parameters:

  • columnNames (Array<String>) —

    Array<String>

#setCustomRowFunction(colNum, totalsCalculation, isArray = false) ⇒ void

集計行の計算方法の設定(カスタム)を行います。

Parameters:

  • colNum (Integer) —

    列番号(先頭=1)

  • totalsCalculation (RubyOSBXL::Enums::XlTotalsCalculation) —

    集計行の計算方法(カスタム)

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

    true: array関数として複数列に適用する false: 通常関数を適用する

#setCustomTableStyleName(customTableStyleName, clearFormat) ⇒ void

テーブルスタイル名の設定を行います。

Parameters:

  • customTableStyleName (String) —

    テーブルスタイル名

  • clearFormat (bool) —

    true : セルの書式を一旦クリアした後、テーブルスタイルを適用する false: 今の状態に適用する

#setShowAutoFilter(showAutoFilter) ⇒ void

オートフィルターの表示有無の設定を行います。

Parameters:

  • showAutoFilter (bool) —

    true: オートフィルター表示のテーブルスタイルを適用する false: オートフィルター表示のテーブルスタイルを適用しない

#setShowHeaders(showHeaders) ⇒ void

ヘッダの表示有無の設定を行います。

Parameters:

  • showHeaders (bool) —

    true: ヘッダを表示する false: ヘッダを表示しない

#setShowTableStyleColumnStripes(showTableStyleColumnStripes) ⇒ void

テーブルスタイルの適用有無（１行おき：列）の設定を行います。

Parameters:

  • showTableStyleColumnStripes (bool) —

    true: （１行おき：列）のテーブルスタイルを適用する false: （１行おき：列）のテーブルスタイルを適用しない

#setShowTableStyleFirstColumn(showTableStyleFirstColumn) ⇒ void

テーブルスタイルの適用有無（最初列）の設定を行います。

Parameters:

  • showTableStyleFirstColumn (bool) —

    true: 最初列のテーブルスタイルを適用する false: 最初列のテーブルスタイルを適用しない

#setShowTableStyleLastColumn(showTableStyleLastColumn) ⇒ void

テーブルスタイルの適用有無（最後行）の設定を行います。

Parameters:

  • showTableStyleLastColumn (bool) —

    true: 最後列のテーブルスタイルを適用する false: 最後列のテーブルスタイルを適用しない

#setShowTableStyleRowStripes(showTableStyleRowStripes) ⇒ void

テーブルスタイルの適用有無（１行おき：行）の設定を行います。

Parameters:

  • showTableStyleRowStripes (bool) —

    true: （１行おき：行）のテーブルスタイルを適用する false: （１行おき：行）のテーブルスタイルを適用しない

#setShowTotals(showTotals) ⇒ void

集計行の表示有無の設定を行います。

Parameters:

  • showTotals (bool) —

    true: 集計行を表示する false: 集計行を表示しない

#setTotalRowFunction(colNum, totalsCalculation) ⇒ void

集計行の計算方法の設定を行います。

Parameters:

#setTotalRowLabel(colNum, totalRowLabel) ⇒ void

集計行のラベル名の設定を行います。

Parameters:

  • colNum (Integer) —

    列番号(先頭=1)

  • totalRowLabel (String) —

    集計行のラベル名