ig.excel.ConditionBase

書式設定ルールの条件をカプセル化する抽象基本クラス。

依存関係

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。
  • ig.excel.ConditionBase
    コンストラクター

    new $.ig.excel.ConditionBase( );

    内部使用のみ。

  • conditionType

    .conditionType( );

    このインスタンスの条件のタイプを識別する FormatConditionType 値を返します。

  • priority

    .priority( );

    複数の条件付き書式ルールが存在する場合に評価の順序を決定する値を返します。

    備考

    デフォルトで、条件は、含まれているコレクション内に現れる順序で評価されます。

    このプロパティを使用すると、条件のコレクションでの順序位置をオーバーライドできます。

    より低い数値がより優先されます。たとえば、優先が 1 に設定される条件が 2 の優先の条件の前に評価されます。

    セル値が複数の条件に一致する場合、最初に評価された条件によって定義される書式は優先があります。

    1 つ以上の条件で優先を設定する場合、各条件に一意の値があることを確認するためにコレクションのその他の条件の値を変更する可能性があります。

  • priority

    .priority( value:number );

    複数の条件付き書式ルールが存在する場合に評価の順序を決定する値を返します。

    • value
    • タイプ:number

    備考

    デフォルトで、条件は、含まれているコレクション内に現れる順序で評価されます。

    このプロパティを使用すると、条件のコレクションでの順序位置をオーバーライドできます。

    より低い数値がより優先されます。たとえば、優先が 1 に設定される条件が 2 の優先の条件の前に評価されます。

    セル値が複数の条件に一致する場合、最初に評価された条件によって定義される書式は優先があります。

    1 つ以上の条件で優先を設定する場合、各条件に一意の値があることを確認するためにコレクションのその他の条件の値を変更する可能性があります。

  • regions

    .regions( );

    この条件が関連するセル範囲を識別する WorksheetRegion を返します。

  • setFirstPriority

    .setFirstPriority( );

    このルールが最初の評価される条件になるために ConditionBase.priority 値を設定します。関連するコレクションに複数の要素が含まれる場合のみに適用できます。

    備考

    複数の条件が同じコレクションに存在する場合、評価の順序はこの条件に一致するセルに適用される書式に影響します。

    このメソッドは、関連する条件を最初に評価される条件に設定します。

    条件を最後に評価される条件に設定するには、ConditionBase.setLastPriority メソッドを使用します。

  • setLastPriority

    .setLastPriority( );

    このルールが最後の評価される条件になるために ConditionBase.priority 値を設定します。関連する ConditionalFormatCollection に複数の要素が含まれる場合のみに適用できます。

    備考

    ConditionBase.setFirstPriority メソッドは関連する条件を最初に評価されることを設定する通り、SetLastPriority メソッドは関連する条件を最後に評価されることを設定します。

    このメソッドを複数の条件で呼び出す場合、以前設定した最後に評価される条件と置き換えます。

  • setRegions

    .setRegions( regionAddress:string, cellReferenceMode:ig.excel.CellReferenceMode );

    既存の領域を新しい領域と置き換えます。

    • regionAddress
    • タイプ:string
    • コンマに分割される領域アドレスを 1 つ以上含む文字列。
    • cellReferenceMode
    • タイプ:ig.excel.CellReferenceMode
    • オプションのセル参照モード。

    例外

    例外 説明
    ig.ArgumentException regionAddress が無効か、その他のワークシートからの領域を含む場合。
  • stopIfTrue

    .stopIfTrue( );

    このルールが true に評価する場合、追加の書式ルールが評価されるかどうかを示すブール値を返します。含まれるコレクションが複数の要素を含む場合のみに適用されます。

    備考

    セル値が複数の条件に一致する場合、最初の条件によって定義される書式は優先があります。書式プロパティは解決処理で結合されます。たとえば、1 つの書式設定に赤い境界線があり、その他の書式設定に赤い前景色がある場合、その 2 つの条件に一致するセル値の書式設定は赤い境界線および赤い前景色になります。

    このプロパティを使用すると、解決処理をオーバーライドできます。つまり、最初の条件が true に評価した後、その他の条件付き書式が適用されないために設定できます。

    上記の例で、StopIfTrue が赤い境界線の条件付き書式で true の値に設定され、赤い前景色のその他の条件付き書式があり、セル値がその両方の条件に一致する場合があります。StopIfTrue 設定が追加の書式の評価を許可しないため、セルが赤い前景色を表示しません。ただし、StopIfTrue が false に設定される場合、赤い境界線および赤い前景色を表示します。

    次の条件の評価を許可しない機能に追加して、ConditionBase.priority プロパティを使用して条件の評価順序を制御できます。

  • stopIfTrue

    .stopIfTrue( value:boolean );

    このルールが true に評価する場合、追加の書式ルールが評価されるかどうかを示すブール値を返します。含まれるコレクションが複数の要素を含む場合のみに適用されます。

    • value
    • タイプ:boolean

    備考

    セル値が複数の条件に一致する場合、最初の条件によって定義される書式は優先があります。書式プロパティは解決処理で結合されます。たとえば、1 つの書式設定に赤い境界線があり、その他の書式設定に赤い前景色がある場合、その 2 つの条件に一致するセル値の書式設定は赤い境界線および赤い前景色になります。

    このプロパティを使用すると、解決処理をオーバーライドできます。つまり、最初の条件が true に評価した後、その他の条件付き書式が適用されないために設定できます。

    上記の例で、StopIfTrue が赤い境界線の条件付き書式で true の値に設定され、赤い前景色のその他の条件付き書式があり、セル値がその両方の条件に一致する場合があります。StopIfTrue 設定が追加の書式の評価を許可しないため、セルが赤い前景色を表示しません。ただし、StopIfTrue が false に設定される場合、赤い境界線および赤い前景色を表示します。

    次の条件の評価を許可しない機能に追加して、ConditionBase.priority プロパティを使用して条件の評価順序を制御できます。

  • workbook

    .workbook( );

    関連付けられたワークブックへの参照を返します。

  • worksheet

    .worksheet( );

    関連付けられたワークシートへの参照を返します。

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.