Class: RubyOSBXL::FormatConditions

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

Overview

Note:

osbxlでは、各種条件(複数可)を設定後、apply()メソッドを呼び計算を反映させる必要があります。

Note:

apply()メソッドの呼び出しを忘れないでください。

条件付き書式クラスクラス条件付き書式を扱うクラスです。ワークシートから使用します。

Instance Method Summary collapse

Instance Method Details

#apply ⇒ void

Note:

設定したFormatConditionsの適用を行います。

Note:

このメソッドは全条件設定後に、必ず、呼び出す必要があります。

条件付き書式の適用を行います。

#getAboveAverageCondition(priority) ⇒ RubyOSBXL::Dto::AboveAverageObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が発行されます。

AboveAverageCondition(平均値より上位/下位による条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getAppliedBordersObject(a1c1) ⇒ Hash<String, RubyOSBXL::Dto::BordersObject>

Note:

返却値のStringは、セル範囲です。

Note:

条件付き書式が適用されているセルのみを返却します。

セル範囲の設定された条件付き書式の枠線の書式(一括)を取得します。

Parameters:

  • a1c1 (String) —

    セル範囲

Returns:

#getAppliedDataBar(a1c1) ⇒ Hash<String, bool>

Note:

返却値のStringは、セル範囲です。

Note:

条件付き書式が適用されているセルのみを返却します。

セル範囲の設定された条件付き書式のデータバーが含まれているか取得します。

Parameters:

  • a1c1 (String) —

    セル範囲

Returns:

  • (Hash<String, bool>) —

    Map<セル範囲, データバーが含まれているか(True: 含まれている)>

#getAppliedFillObject(a1c1) ⇒ Hash<String, RubyOSBXL::Dto::FillObject>

Note:

返却値のStringは、セル範囲です。

Note:

条件付き書式が適用されているセルのみを返却します。

セル範囲の設定された条件付き書式の塗りつぶし書式を取得します。

Parameters:

  • a1c1 (String) —

    セル範囲

Returns:

#getAppliedFontObject(a1c1) ⇒ Hash<String, String>

Note:

返却値のStringは、セル範囲です。

Note:

条件付き書式が適用されているセルのみを返却します。

セル範囲の設定された条件付き書式のフォント書式を取得します。

Parameters:

  • a1c1 (String) —

    セル範囲

Returns:

  • (Hash<String, String>) —

    Map<セル範囲, フォントオブジェクト>

#getAppliedIconSetObject(a1c1) ⇒ Hash<String, RubyOSBXL::Dto::FilterIconsetObject>

Note:

返却値のStringは、セル範囲です。

Note:

条件付き書式が適用されているセルのみを返却します。

セル範囲の設定された条件付き書式のアイコンセットの書式を取得します。

Parameters:

  • a1c1 (String) —

    セル範囲

Returns:

#getAppliedNumberFormat(a1c1) ⇒ Hash<String, String>

Note:

返却値のStringは、セル範囲です。

Note:

条件付き書式が適用されているセルのみを返却します。

セル範囲の設定された条件付き書式のセル表示書式を取得します。

Parameters:

  • a1c1 (String) —

    セル範囲

Returns:

  • (Hash<String, String>) —

    Map<セル範囲, セル表示書式>

#getCellValueCondition(priority) ⇒ RubyOSBXL::Dto::CellValueObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が

CellValueCondition(セル値による条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getCellValueRangeCondition(priority) ⇒ RubyOSBXL::Dto::CellValueRangeObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が発行

CellValueRangeCondition(セル値範囲による条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getColorScaleFormatCondition(priority) ⇒ RubyOSBXL::Dto::ColorScaleObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が発行されます。

ColorScaleCondition(グラデーション色による条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getConditionTypes ⇒ Hash<Integer, Hash<String, RubyOSBXL::Enums::XlFormatConditionType>>

Note:

返却値のstringは、セル範囲です。

Note:

返却値のintは、priorityです。1から始まります。

Note:

osbxlでは、priorityは、シート単位で一意に設定します。

全条件付き書式の条件タイプ(どの種類を用いた条件付き書式なのか)を取得します。

Returns:

  • (Hash<Integer, Hash<String, RubyOSBXL::Enums::XlFormatConditionType>>) —

    Map<プライオリティ(適用順序、値が低いほど先に適用する), Map<セル範囲, 条件付き書式の条件タイプ>>

#getDataBarFormatCondition(priority) ⇒ RubyOSBXL::Dto::DataBarObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外

DataBarCondition(データバーによる条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getIconsetFormatCondition(priority) ⇒ RubyOSBXL::Dto::IconsetConditionObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が発行されます。

IconsetCondition(アイコンセットによる条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getTop10FormatCondition(priority) ⇒ RubyOSBXL::Dto::Top10Object

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が発行されます。

Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#getUniqueValuesFormatCondition(priority) ⇒ RubyOSBXL::Dto::UniqueValuesObject

Note:

priorityは、条件のn番目を意味します。条件の先頭=1です。priorityと条件タイプがあっていない場合、例外が発行されます。

UniqueValueCondition(ユニーク値による条件付き書式)を取得します。

getConditionTypesメソッドで、条件タイプ取得が可能です。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

Returns:

#removeAllCondition ⇒ void

条件付き書式の条件の全削除を行います。

#removeCondition(priority) ⇒ void

条件付き書式の条件の個別削除を行います。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

#setAboveAverageCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

AboveAverageCondition(平均値より上位による条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::AboveAverageObject) —

    条件付き書式平均値上位オブジェクト

#setCellValueCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

CellValueCondition(セル値による条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::CellValueObject) —

    条件付き書式セル値オブジェクト

#setCellValueRangeCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

CellValueRangeCondition(セル値範囲による条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::CellValueRangeObject) —

    条件付き書式セル値範囲オブジェクト

#setColorScaleFormatCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

ColorScaleCondition(グラデーション色による条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::ColorScaleObject) —

    条件付き書式グラデーション色オブジェクト

#setDataBarFormatCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

DataBarCondition(データバーによる条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::DataBarObject) —

    条件付き書式データバーオブジェクト

#setIconsetFormatCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

IconsetCondition(アイコンセットによる条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::IconsetConditionObject) —

    条件付き書式アイコンセットオブジェクト

#setTop10FormatCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::Top10Object) —

    条件付き書式上位下位オブジェクト

#setUniqueValuesFormatCondition(priority, condition) ⇒ void

Note:

prirorityが既に存在する場合、存在するpriorityを後ろにずらします。

UniqueValueCondition(ユニーク値による条件付き書式)を設定します。

Parameters:

  • priority (Integer) —

    プライオリティ(適用順序、値が低いほど先に適用する)

  • condition (RubyOSBXL::Dto::UniqueValuesObject) —

    条件付き書式ユニーク値オブジェクト