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

Constructors

Section titled "Constructors"

ConditionBase 

new ConditionBase(): ConditionBase

Returns ConditionBase

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

conditionType

Section titled "conditionType"

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

 
get conditionType(): FormatConditionType

Returns FormatConditionType

priority

Section titled "priority"

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

 
get priority(): number

Returns number 

set priority(a: number): void

Parameters

  • a: number

Returns void

regions

Section titled "regions"

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

 
get regions(): ReadOnlyCollection$1<WorksheetRegion>

Returns ReadOnlyCollection$1<WorksheetRegion>

stopIfTrue

Section titled "stopIfTrue"

Returns or 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.

 
get stopIfTrue(): boolean

Returns boolean 

set stopIfTrue(a: boolean): void

Parameters

  • a: boolean

Returns void

workbook

Section titled "workbook"

Returns a reference to the associated workbook.

 
get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Returns a reference to the associated worksheet.

 
get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setFirstPriority

Section titled "setFirstPriority"

Sets the [[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.

 
setFirstPriority(): void

Returns void

setLastPriority

Section titled "setLastPriority"

Sets the [[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]].

 
setLastPriority(): void

Returns void

setRegions

Section titled "setRegions"

Replaces the existing regions with new ones

 
setRegions(regionAddress: string, cellReferenceMode: CellReferenceMode | null): void

Parameters

  • regionAddress: string

    A string with one or more comma separated region address
  • cellReferenceMode: CellReferenceMode | null

    An optional cell reference mode

Returns void

staticInit

Section titled "staticInit" 
staticInit(): void

Returns void