Exposes properties which control the visual attributes of a [[WorksheetCell]] based on whether the cell's text value meets the criteria defined by a string and a [[FormatConditionTextOperator]] value.

Constructors

Section titled "Constructors"

TextOperatorConditionalFormat

new TextOperatorConditionalFormat(a: number): TextOperatorConditionalFormat

Returns TextOperatorConditionalFormat

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

priority

Section titled "priority"

Inherited from: ConditionalFormatBase 

priority: number

stopIfTrue

Section titled "stopIfTrue"

Inherited from: ConditionalFormatBase 

stopIfTrue: boolean

text

Section titled "text" 
text: string

textOperator

Section titled "textOperator" 
textOperator: FormatConditionTextOperator

Accessors

Section titled "Accessors"

cellFormat

Section titled "cellFormat"

Inherited from: ConditionalFormatBase

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: ConditionalFormatBase

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

get conditionType(): FormatConditionType

Returns FormatConditionType

regions

Section titled "regions"

Inherited from: ConditionalFormatBase

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

get regions(): ReadOnlyCollection$1<WorksheetRegion>

Returns ReadOnlyCollection$1<WorksheetRegion>

textFormula

Section titled "textFormula"

Returns the formula which defines the string value against which cell text is compared.

get textFormula(): Formula

Returns Formula

workbook

Section titled "workbook"

Inherited from: ConditionalFormatBase

Returns a reference to the associated workbook.

get workbook(): Workbook

Returns Workbook

worksheet

Section titled "worksheet"

Inherited from: ConditionalFormatBase

Returns a reference to the associated worksheet.

get worksheet(): Worksheet

Returns Worksheet

Methods

Section titled "Methods"

setFirstPriority

Section titled "setFirstPriority"

Inherited from: ConditionalFormatBase

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: ConditionalFormatBase

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: ConditionalFormatBase

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

setTextFormula

Section titled "setTextFormula"

Assigns a [[Formula]] to the [[textFormula]] property.

setTextFormula(formula: string, cellReferenceMode: CellReferenceMode): void

Parameters

  • formula: string

    The string representation of the [[Formula]] to be assigned to the [[textFormula]] property.
  • cellReferenceMode: CellReferenceMode

    A [[CellReferenceMode]] value which specifies whether the 'formula' parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the [[Workbook.cellReferenceMode]] property is used.

Returns void

staticInit

Section titled "staticInit"

Inherited from: ConditionalFormatBase 

staticInit(): void

Returns void