Abstract base class for classes which control the visual attributes of a [[WorksheetCell]], based on whether the cell's value meets a logical condition.

Constructors

Section titled "Constructors"

ConditionalFormatBase

new ConditionalFormatBase(): ConditionalFormatBase

Returns ConditionalFormatBase

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

priority

Section titled "priority"

Inherited from: ConditionBase 

priority: number

stopIfTrue

Section titled "stopIfTrue"

Inherited from: ConditionBase 

stopIfTrue: boolean

Accessors

Section titled "Accessors"

cellFormat

Section titled "cellFormat"

Returns an [[IWorksheetCellFormat]] interface implementation which represents the format for cells which meet the criteria associated with this condition.

get cellFormat(): IWorksheetCellFormat

Returns IWorksheetCellFormat

conditionType

Section titled "conditionType"

Inherited from: ConditionBase

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

get conditionType(): FormatConditionType

Returns FormatConditionType

regions

Section titled "regions"

Inherited from: ConditionBase

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

get regions(): ReadOnlyCollection$1<WorksheetRegion>

Returns ReadOnlyCollection$1<WorksheetRegion>

workbook

Section titled "workbook"

Inherited from: ConditionBase

Returns a reference to the associated workbook.

get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ConditionBase

Returns a reference to the associated worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setFirstPriority

Section titled "setFirstPriority"

Inherited from: ConditionBase

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"

Inherited from: ConditionBase

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"

Inherited from: ConditionBase

Replaces the existing regions with new ones

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

Parameters

  • regionAddress: string

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

    An optional cell reference mode

Returns void

staticInit

Section titled "staticInit"

Inherited from: ConditionBase 

staticInit(): void

Returns void