ig.excel.ConditionalFormatCollection
備考
ワークシート セルの領域で条件付き書式を有効にするには、ConditionBase から派生するインスタンスをこのコレクションに追加します。
このコレクションは、利用可能な条件付き書式の各タイプのために Add メソッドを公開します。
たとえば、値および論理演算子に基づく条件付き書式を追加するには、ConditionalFormatCollection.addOperatorCondition メソッドを使用します。
ConditionalFormatBase から派生する条件付き書式クラスは CellFormat プロパティを公開します。そのプロパティが条件に一致するセルのビジュアル属性を制御するプロパティを公開します。この書式設定は条件に一致する値を持つセルに適用されます。
依存関係
-
addAverageCondition
- .addAverageCondition( regionAddress:string, [aboveBelow:ig.excel.FormatConditionAboveBelow] );
- 返却型:
- ig.excel.AverageConditionalFormat
- 返却型の説明:
- 結果の AverageConditionalFormat。
このコレクションに新しい AverageConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- aboveBelow
- タイプ:ig.excel.FormatConditionAboveBelow
- オプション
- AverageConditionalFormat.aboveBelow プロパティの初期値を定義する FormatConditionAboveBelow 値。このパラメーターはオプションであり、デフォルト値は AboveAverage です。
-
addBlanksCondition
- .addBlanksCondition( regionAddress:string );
- 返却型:
- ig.excel.BlanksConditionalFormat
- 返却型の説明:
- 結果の BlanksConditionalFormat インスタンス。
このコレクションに新しい BlanksConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
-
addColorScaleCondition
- .addColorScaleCondition( regionAddress:string, colorScaleType:ig.excel.ColorScaleType );
- 返却型:
- ig.excel.ColorScaleConditionalFormat
- 返却型の説明:
- 結果の ColorScaleConditionalFormat インスタンス。
このコレクションに新しい ColorScaleConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- colorScaleType
- タイプ:ig.excel.ColorScaleType
- 2 色または 3 色スケールを追加するかどうかを決定する ColorScaleType 値。
備考
注: TwoColor が colorScaleType パラメーターの値として指定される場合、ColorScaleConditionalFormat.midpointThreshold プロパティは適用できません。そのプロパティから返されたオブジェクトにプロパティを設定すると、例外を発生する原因になります。
ColorScaleConditionalFormat.minimumThreshold および ColorScaleConditionalFormat.maximumThreshold プロパティが関連する範囲の最小ポイントおよび最大ポイントの色設定およびしきい値境界をカスタマイズするために使用できます。
3 色スケールの場合、中値のしきい値境界をカスタマイズするために ColorScaleConditionalFormat.midpointThreshold を使用できます。
-
addDataBarCondition
- .addDataBarCondition( regionAddress:string );
- 返却型:
- ig.excel.DataBarConditionalFormat
- 返却型の説明:
- 結果の DataBarConditionalFormat インスタンス。
このコレクションに新しい DataBarConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
-
addDateTimeCondition
- .addDateTimeCondition( regionAddress:string, [dateOperator:ig.excel.FormatConditionTimePeriod] );
- 返却型:
- ig.excel.DateTimeConditionalFormat
- 返却型の説明:
- 結果の DateTimeConditionalFormat インスタンス。
このコレクションに新しい DateTimeConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- dateOperator
- タイプ:ig.excel.FormatConditionTimePeriod
- オプション
- セルの日付値が評価される時間範囲を定義する FormatConditionTimePeriod。このパラメーターはオプションであり、デフォルト値は Today です。
-
addDuplicateCondition
- .addDuplicateCondition( regionAddress:string );
- 返却型:
- ig.excel.DuplicateConditionalFormat
- 返却型の説明:
- 結果の DuplicateConditionalFormat インスタンス。
このコレクションに複製の値条件として構成される新しい DuplicateConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
備考
関連する範囲で一意ではないセル値の場合のみに true に評価する条件を追加するためにこのメソッドを使用します。
-
addErrorsCondition
- .addErrorsCondition( regionAddress:string );
- 返却型:
- ig.excel.ErrorsConditionalFormat
- 返却型の説明:
- 結果の ErrorsConditionalFormat インスタンス。
このコレクションに新しい ErrorsConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
-
addFormulaCondition
- .addFormulaCondition( regionAddress:string, formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );
- 返却型:
- ig.excel.FormulaConditionalFormat
- 返却型の説明:
- 結果の FormulaConditionalFormat インスタンス。
このコレクションに新しい FormulaConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- formula
- タイプ:string
- セル値が条件に合うかどうかを決定するために使用される数式。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- オプション
- formula パラメーターが A1 または R1C1 式として解析するかどうかを指定する CellReferenceMode 値。このプロパティはオプションで、デフォルト値は null です。この場合、Workbook.cellReferenceMode プロパティが使用されます。
関連項目
-
addIconSetCondition
- .addIconSetCondition( regionAddress:string, [iconSet:ig.excel.FormatConditionIconSet] );
- 返却型:
- ig.excel.IconSetConditionalFormat
- 返却型の説明:
- 結果の IconSetConditionalFormat インスタンス。
このコレクションに新しい IconSetConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- iconSet
- タイプ:ig.excel.FormatConditionIconSet
- オプション
- 使用するアイコン セットを識別する FormatConditionIconSet 値。このパラメーターはオプションであり、デフォルト値は IconSet3TrafficLights1 です。
備考
FormatConditionIconSet 列挙体で各定数は名前に 3、4、または 5 を含みます。この数は条件でサポートされるしきい値の数を識別します。
3 しきい値条件は 33%、67%、および 100% のしきい値をサポートします。
4 しきい値条件は 25%、50%、75%、および 100% のしきい値をサポートします。
5 しきい値条件は 20%、40%、60%、80%、および 100% のしきい値をサポートします。
各しきい値のための ColorScaleCriterion オブジェクトが IconSetConditionalFormat.iconCriteria コレクションから返されます。
このオブジェクトを使用すると、相対するしきい値の値をカスタマイズできます。たとえば、指定したインデックスで表示されるアイコンが IconCriterion.icon プロパティを使用してオーバーライドできます。
関連項目
-
addNoBlanksCondition
- .addNoBlanksCondition( regionAddress:string );
- 返却型:
- ig.excel.NoBlanksConditionalFormat
- 返却型の説明:
- 結果の NoBlanksConditionalFormat インスタンス。
このコレクションに新しい NoBlanksConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
-
addNoErrorsCondition
- .addNoErrorsCondition( regionAddress:string );
- 返却型:
- ig.excel.NoErrorsConditionalFormat
- 返却型の説明:
- 結果の NoErrorsConditionalFormat インスタンス。
このコレクションに新しい NoErrorsConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
関連項目
-
addOperatorCondition
- .addOperatorCondition( regionAddress:string, [conditionOperator:ig.excel.FormatConditionOperator] );
- 返却型:
- ig.excel.OperatorConditionalFormat
- 返却型の説明:
- 結果の OperatorConditionalFormat インスタンス。
このコレクションに新しい OperatorConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- conditionOperator
- タイプ:ig.excel.FormatConditionOperator
- オプション
- OperatorConditionalFormat.operator プロパティの初期値を定義する FormatConditionOperator 値。このパラメーターはオプションであり、デフォルト値は Equal です。
-
addRankCondition
- .addRankCondition( regionAddress:string, [topBottom:ig.excel.FormatConditionTopBottom], [rank:number] );
- 返却型:
- ig.excel.RankConditionalFormat
- 返却型の説明:
- 結果の RankConditionalFormat インスタンス。
このコレクションに新しい RankConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- topBottom
- タイプ:ig.excel.FormatConditionTopBottom
- オプション
- ランキングの上または下が評価されたかどうかを決定する FormatConditionTopBottom 値。このパラメーターはオプションであり、デフォルト値は Top です。
- rank
- タイプ:number
- オプション
- 数値、パーセンテージ、またはパーセンタイル ランキング。このパラメーターはオプションであり、デフォルト値は 10 です。
備考
RankConditionalFormat が使用可能です。たとえば、指定したセル範囲の「上位 10」の値を書式設定するために使用できます。
上位または下位の値の数を変更するには RankConditionalFormat.rank プロパティを使用します。
-
addTextCondition
- .addTextCondition( regionAddress:string, [text:string], [textOperator:ig.excel.FormatConditionTextOperator] );
- 返却型:
- ig.excel.TextOperatorConditionalFormat
- 返却型の説明:
- 結果の TextOperatorConditionalFormat インスタンス。
このコレクションに新しい TextOperatorConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
- text
- タイプ:string
- オプション
- セルのテキスト値が評価される文字列を決定する文字列。このパラメーターはオプションであり、デフォルト値は null です。
- textOperator
- タイプ:ig.excel.FormatConditionTextOperator
- オプション
- セル値がテキスト値に比較される方法を決定する FormatConditionTextOperator 値。このパラメーターはオプションであり、デフォルト値は BeginsWith です。
-
addUniqueCondition
- .addUniqueCondition( regionAddress:string );
- 返却型:
- ig.excel.UniqueConditionalFormat
- 返却型の説明:
- 結果の UniqueConditionalFormat インスタンス。
このコレクションに一意の値条件として構成される新しい UniqueConditionalFormat インスタンスを追加します。
- regionAddress
- タイプ:string
- この条件付き書式が適用される領域を識別する文字列。
備考
関連する範囲で一意のセル値の場合のみに true に評価する条件を追加するためにこのメソッドを使用します。
-
clear
- .clear( );
このコレクションからすべての項目を削除します。
-
contains
- .contains( condition:ig.excel.ConditionBase );
コレクションが条件を含む場合 true を返します。
- condition
- タイプ:ig.excel.ConditionBase
- 条件。
-
count
- .count( );
コレクションに含まれる項目の合計数を返します。
-
getEnumerator
- .getEnumerator( );
コレクションで項目の列挙体を返します。
-
indexOf
- .indexOf( condition:ig.excel.ConditionBase );
- 返却型:
- number
- 返却型の説明:
- インデックス、または項目がコレクションにない場合 -1。
コレクションに含まれる項目のインデックスを取得します。
- condition
- タイプ:ig.excel.ConditionBase
-
item
- .item( index:number );
- 返却型:
- ig.excel.ConditionBase
- 返却型の説明:
- 指定されたインデックスにある項目。
インデクサー
- index
- タイプ:number
- 項目のゼロから始まるインデックス。
例外
例外 説明 ig.IndexOutOfRangeException インデックスが負の数、または ConditionalFormatCollection.count 以上の値の場合。 -
remove
- .remove( condition:ig.excel.ConditionBase );
- 返却型:
- boolean
- 返却型の説明:
- 項目が削除された場合 true。項目がコレクションになかった場合 false。
コレクションから項目を削除します。
- condition
- タイプ:ig.excel.ConditionBase
-
removeAt
- .removeAt( index:number );
指定したインデックスにある項目をコレクションから削除します。
- index
- タイプ:number
- コレクションの 0 から始まるインデックス。