Class: RubyOSBXL::Dto::SortFieldObject

Inherits:

Object

• Object
• RubyOSBXL::Dto::SortFieldObject

Defined in:

lib/rubyosbxl.rb

Overview

通常のワークシートの他、オートフィルター、テーブルから使用できます。

Instance Method Summary

• #getCellColor ⇒ RubyOSBXL::Dto::FillObject

  並び替え条件のセルのフィルオブジェクトを取得します。.

• #getDirection ⇒ RubyOSBXL::Enums::XlRowCol

  並び替えの向きを取得します。テーブルでは、行方向のみとなります。.

• #getFontColor ⇒ RubyOSBXL::Dto::ColorObject

  並び替え条件のセルのフォント色を取得します。.

• #getIconId ⇒ Integer

  アイコンセットによる並び替えを行う時、対象のアイコンセットの中のアイコンIDを取得します。.

• #getIconSet ⇒ RubyOSBXL::Enums::XlFilterIconSet

  アイコンセットによる並び替えを行う時、対象のアイコンセットを取得します。.

• #getMatchCase ⇒ bool

  アルファベットの大文字小文字を無視するか取得します。.

• #getSortAscending ⇒ bool

  昇順の並び替えかえを行うか降順の並び替えを行うか取得します。.

• #getSortOn ⇒ RubyOSBXL::Enums::XlSortOn

  並び替えのキーとなる対象を取得します。.

• #getTarget ⇒ Numeric

  対象が何列目か取得します。.

• #getTargetA1 ⇒ String

  並び替えがフォント色またはセルの背景の時に使用するキーとなる色をもつセルを取得します。.

• #initialize ⇒ void constructor

  コンストラクタ.

• #setCellColor(cellColor) ⇒ void

  並び替え条件のセルにフィルオブジェクトを適用します。.

• #setDirection(direction) ⇒ void

  並び替えの向きを設定します。.

• #setFontColor(fontColor) ⇒ void

  並び替え条件のセルのフォントに色オブジェクトを適用します。.

• #setMatchCase(matchCase) ⇒ void

  アルファベットの大文字小文字を無視するか設定します。.

• #setSortOnCellColor(target, a1, asceding) ⇒ void

  セルの背景色による並び替えを設定します。.

• #setSortOnFontColor(target, a1, asceding) ⇒ void

  フォント色による並び替えを設定します。.

• #setSortOnIcon(target, iconSet, iconId, asceding) ⇒ void

  アイコンによる並び替えを設定します。.

• #setSortOnValues(target, asceding) ⇒ void

  セル値による並び替えを設定します。.

Constructor Details

#initialize ⇒ void

コンストラクタ

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

Instance Method Details

#getCellColor ⇒ RubyOSBXL::Dto::FillObject

並び替え条件のセルのフィルオブジェクトを取得します。

Returns:

• (RubyOSBXL::Dto::FillObject) —

  セルのフィルオブジェクト

#getDirection ⇒ RubyOSBXL::Enums::XlRowCol

並び替えの向きを取得します。テーブルでは、行方向のみとなります。

Returns:

• (RubyOSBXL::Enums::XlRowCol) —

  並び替えの向き

#getFontColor ⇒ RubyOSBXL::Dto::ColorObject

並び替え条件のセルのフォント色を取得します。

Returns:

• (RubyOSBXL::Dto::ColorObject) —

  セルのフォント色

#getIconId ⇒ Integer

アイコンセットによる並び替えを行う時、対象のアイコンセットの中のアイコンIDを取得します。

Returns:

• (Integer) —

  アイコンID 先頭アイコンは、1となります。

#getIconSet ⇒ RubyOSBXL::Enums::XlFilterIconSet

アイコンセットによる並び替えを行う時、対象のアイコンセットを取得します。

Returns:

• (RubyOSBXL::Enums::XlFilterIconSet) —

  アイコンセット

#getMatchCase ⇒ bool

アルファベットの大文字小文字を無視するか取得します。

Returns:

• (bool) —

  true: 無視する false: 無視しない

#getSortAscending ⇒ bool

昇順の並び替えかえを行うか降順の並び替えを行うか取得します。

Returns:

• (bool) —

  true: 昇順 false: 降順

#getSortOn ⇒ RubyOSBXL::Enums::XlSortOn

並び替えのキーとなる対象を取得します。

Returns:

• (RubyOSBXL::Enums::XlSortOn) —

  並び替えのキーとなる対象

#getTarget ⇒ Numeric

対象が何列目か取得します。

Returns:

• (Numeric) —

  列数(先頭=1列目)

#getTargetA1 ⇒ String

並び替えがフォント色またはセルの背景の時に使用するキーとなる色をもつセルを取得します。

Returns:

• (String) —

  セル単一範囲(A1) 空文字は、自動を意味します。

#setCellColor(cellColor) ⇒ void

並び替え条件のセルにフィルオブジェクトを適用します。

Parameters:

• cellColor (RubyOSBXL::Dto::FillObject) —

  フィルオブジェクト

#setDirection(direction) ⇒ void

並び替えの向きを設定します。

Parameters:

• direction (RubyOSBXL::Enums::XlRowCol) —

  向き テーブルでは、行方向のみとなります。

#setFontColor(fontColor) ⇒ void

並び替え条件のセルのフォントに色オブジェクトを適用します。

Parameters:

• fontColor (RubyOSBXL::Dto::ColorObject) —

  色オブジェクト

#setMatchCase(matchCase) ⇒ void

アルファベットの大文字小文字を無視するか設定します。

Parameters:

• matchCase (bool) —

  true: 無視する false: 無視しない

#setSortOnCellColor(target, a1, asceding) ⇒ void

セルの背景色による並び替えを設定します。

Parameters:

• target (Integer) —

  何列目を並び替えるか 先頭列=1となります。

• a1 (String) —

  キーとなる色をもつセルを取得します。空文字の場合、自動となります。

• asceding (bool) —

  true: 昇順 false: 降順

#setSortOnFontColor(target, a1, asceding) ⇒ void

フォント色による並び替えを設定します。

Parameters:

• target (Integer) —

  何列目を並び替えるか 先頭列=1となります。

• a1 (String) —

  キーとなる色をもつセルを取得します。空文字の場合、自動となります。

• asceding (bool) —

  true: 昇順 false: 降順

#setSortOnIcon(target, iconSet, iconId, asceding) ⇒ void

アイコンによる並び替えを設定します。

Parameters:

• target (Integer) —

  何列目を並び替えるか 先頭列=1となります。

• iconSet (RubyOSBXL::Enums::XlFilterIconSet) —

  対象アイコンセットを設定します。

• iconId (Integer) —

  対象アイコンセットのうちの何番目のアイコンを並び替えるか設定します（先頭=1となります）

• asceding (bool) —

  true: 昇順 false: 降順

#setSortOnValues(target, asceding) ⇒ void

セル値による並び替えを設定します。

Parameters:

• target (Integer) —

  何列目を並び替えるか 先頭列=1となります。

• asceding (bool) —

  true: 昇順 false: 降順