Class: RubyOSBXL::Sort

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

Overview

ワークシートのセル範囲の並び替えを扱うクラスです。ワークシート、テーブル、オートフィルターから呼ばれます。

Instance Method Summary collapse

Instance Method Details

#execute(sortFieldObject) ⇒ void

入力された並び替え条件に基づき、並び替えの実行を行います。

Parameters:

#executeMultiple(sortFieldObjects) ⇒ void

入力された並び替え条件群に基づき、並び替えの実行を行います。

Parameters:

#executeSortAscending(target, direction = RubyOSBXL::Enums::XlRowCol::Rows, matchCase = false) ⇒ void

並び替えの実行(昇順)を行います。

Parameters:

  • target (Integer) —

    並び替え対象の列数。先頭(行/列)=1です。

  • direction (RubyOSBXL::Enums::XlRowCol) (defaults to: RubyOSBXL::Enums::XlRowCol::Rows) —

    XlRowCol.Rows: 行方向 XlRowCol.Cols: 列方向 オートフィルターまたはテーブルから呼ばれた際は、行方向のみとなります。

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

    true: 大文字小文字を考慮 false: 大文字小文字を無視

#executeSortDescending(target, direction = RubyOSBXL::Enums::XlRowCol::Rows, matchCase = false) ⇒ void

並び替えの実行(降順)を行います。

Parameters:

  • target (Integer) —

    並び替え対象の列数。先頭(行/列)=1です。

  • direction (RubyOSBXL::Enums::XlRowCol) (defaults to: RubyOSBXL::Enums::XlRowCol::Rows) —

    XlRowCol.Rows: 行方向 XlRowCol.Cols: 列方向 オートフィルターまたはテーブルから呼ばれた際は、行方向のみとなります。

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

    true: 大文字小文字を考慮 false: 大文字小文字を無視

#getSortConditions ⇒ Array<RubyOSBXL::Dto::SortFieldObject>

設定されている並び替え条件を取得します。

Returns:

#resetAllSort ⇒ void

Note:

オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。

並び替え条件を全クリアします。

#resetSort(target) ⇒ void

Note:

オートフィルターとテーブルから並び替えオブジェクトが取得された時に有効です。

並び替え条件をクリアします。

Parameters:

  • target (Integer) —

    並び替え対象の列数。先頭(行/列)=1です。