ig.excel.ConditionBase

Abstract base class which encapsulates the condition for a formatting rule.

Dependencies

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
The current widget has no options.
The current widget has no events.

  • ig.excel.ConditionBase
    Constructor

    new $.ig.excel.ConditionBase( );

    For internal use only

  • conditionType

    .conditionType( );

    Returns a FormatConditionType value which identifies the type of condition for this instance.

  • priority

    .priority( );

    Returns a value which determines the order of evaluation when multiple conditional formatting rules exist.

    Remarks

    By default, conditions are evaluated in the order in which they appear within the containing collection.

    This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.

    A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.

    If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.

    Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.

  • priority

    .priority( value:number );

    Sets a value which determines the order of evaluation when multiple conditional formatting rules exist.

    • value
    • Type:number

    Remarks

    By default, conditions are evaluated in the order in which they appear within the containing collection.

    This property makes it possible to weight one condition over another, essentially overriding the condition's ordinal position within the collection.

    A lower number means a higher priority; for example, a condition with a priority of 1 is evaluated before one with a priority of 2.

    If a cell value meets more than one condition, the format defined by the first condition to be evaluated takes precedence.

    Setting the priority on one condition may cause the value of other conditions in the collection to be changed to ensure that each condition has a unique value.

  • regions

    .regions( );

    Returns the WorksheetRegion which identifies the cell range with which this condition is associated.

  • setFirstPriority

    .setFirstPriority( );

    Sets the ConditionBase.priority value for this rule such that it is the first condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated collection.

    Remarks

    When multiple conditions exist in the same collection, the order in which they are evaluated has bearing on which format is applied to cells which meet those conditions.

    This method ensures that the associated condition is the first one to be evaluated.

    To make a condition the last one to be evaluated, use the ConditionBase.setLastPriority method.

    See Also

  • setLastPriority

    .setLastPriority( );

    Sets the ConditionBase.priority value for this rule such that it is the last condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated ConditionalFormatCollection.

    Remarks

    Just as the ConditionBase.setFirstPriority method ensures that the associated condition is evalulated first, the SetLastPriority method ensures that the associated condition is evaluated last.

    Calling this method on more than one condition essentially replaces the previously designated condition as the last one to be evaluated with this one.

    See Also

  • setRegions

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

    Replaces the existing regions with new ones

    • regionAddress
    • Type:string
    • A string with one or more comma separated region address
    • cellReferenceMode
    • Type:ig.excel.CellReferenceMode
    • An optional cell reference mode

    Exceptions

    Exception Description
    ig.ArgumentException If regionAddress is invalid or contains a region from another worksheet

  • stopIfTrue

    .stopIfTrue( );

    Returns a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing collection contains more than one element.

    Remarks

    If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.

    This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.

    Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.

    In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the ConditionBase.priority property.

  • stopIfTrue

    .stopIfTrue( value:boolean );

    Sets a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing collection contains more than one element.

    • value
    • Type:boolean

    Remarks

    If a cell value meets more than one condition, the format defined by the first condition takes precedence. Individual format properties are "merged" during the resolution process; for example, if one format has red borders and another has a red foreground color, a cell value which meets both conditions may be formatted with both red borders and a red foreground color.

    This property makes it possible to short-circuit the resolution process, so that no other conditional formats are applied after the first condition evaluates to true.

    Using the above example, assume StopIfTrue is set to a value of true on the conditional format with red borders, a second conditional format exists with a red foreground color, and a cell value meets both conditions. Because the StopIfTrue setting prevents additional formats from being evaluated, the cell will not show a red foreground color, whereas with StopIfTrue being set to false, it would show both red borders and a red foreground color.

    In addition to preventing subsequent conditions from being evaluated, the order in which conditions are evaluated can be controlled using the ConditionBase.priority property.

  • workbook

    .workbook( );

    Returns a reference to the associated workbook.

  • worksheet

    .worksheet( );

    Returns a reference to the associated worksheet.

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