Class: RubyOSBXL::ListObjects

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

Overview

ワークシートのテーブル一覧を表すクラスです。テーブルクラスの追加、削除、取得、テーブル範囲変更が可能です。

Instance Method Summary collapse

Instance Method Details

#addList(tableName, a1c1, useFirstRowAsHeader, insertTotals) ⇒ RubyOSBXL::Table

Note:

useFirstRowAsHeaderがtrueの時、1行目をテーブルのヘッダとして使います。falseの時は、テーブルヘッダを自動生成します。

Note:

insertTotalsがtrueの時、末尾に、集計行を自動生成し、追加します。falseの時は、末尾に追加しません。

ワークシートにテーブルを追加します。

Parameters:

  • tableName (String) —

    テーブル名

  • a1c1 (String) —

    追加テーブルのセル範囲(現在のワークシート)

  • useFirstRowAsHeader (bool) —

    true: 1行目をテーブルヘッダとする false: 1行目をテーブルヘッダとしない(テーブルヘッダを自動生成しない)

  • insertTotals (bool) —

    true: 末尾に集計行を追加する false: 末尾に集計行を追加する

Returns:

#addListFromRange(tableName, topA1, copyFromA1C1, useFirstRowAsHeader, insertTotals) ⇒ RubyOSBXL::Table

Note:

useFirstRowAsHeaderがtrueの時、1行目をテーブルのヘッダとして使います。falseの時は、テーブルヘッダを自動生成します。（copyFromA1C1にテーブル名を設定した場合、常にtrueの扱いとなります)

Note:

insertTotalsがtrueの時、末尾に、合計行を自動生成し、追加します。falseの時は、末尾に追加しません。

ワークシートのテーブル作成をデータコピーと共に行います。

Parameters:

  • tableName (String) —

    テーブル名

  • topA1 (String) —

    作成するテーブルの左上のセル(単一セル)

  • copyFromA1C1 (String) —

    作成テーブルにコピーするデータのセル範囲またはテーブル名(他シートからも可能です。他シートの場合、Sheet2!A1: C1のようなシート名を付加した表記となります)

  • useFirstRowAsHeader (bool) —

    true: 1行目をテーブルヘッダとする false: 1行目をテーブルヘッダとしない(テーブルヘッダを自動生成しない)

  • insertTotals (bool) —

    true: 末尾に集計行を追加する false: false: 末尾に集計行を追加する

Returns:

#getList(tableName) ⇒ RubyOSBXL::Table

テーブルクラスを取得します。

Parameters:

  • tableName (String) —

    テーブル名

Returns:

#removeList(tableName, deleteData = true) ⇒ void

ワークシートからのテーブルの削除を行います。

Parameters:

  • tableName (String) —

    テーブル名

  • deleteData (bool) (defaults to: true) —

    true: データの削除を行う false: データを残す