Abstract base class which encapsulates the condition for a formatting rule.
Constructors
Section titled "Constructors"ConditionBase
new ConditionBase(): ConditionBaseReturns ConditionBase
Properties
Section titled "Properties"$t: Typepriority
Section titled "priority"priority: numberstopIfTrue
Section titled "stopIfTrue"stopIfTrue: booleanAccessors
Section titled "Accessors"conditionType
Section titled "conditionType"Returns a [[FormatConditionType]] value which identifies the type of condition for this instance.
get conditionType(): FormatConditionTypeReturns FormatConditionType
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>
workbook
Section titled "workbook"worksheet
Section titled "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(): voidReturns 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(): voidReturns void
setRegions
Section titled "setRegions"Replaces the existing regions with new ones
setRegions(regionAddress: string, cellReferenceMode: CellReferenceMode): voidParameters
- regionAddress:
stringA string with one or more comma separated region address
- cellReferenceMode:
CellReferenceModeAn optional cell reference mode
Returns void
staticInit
Section titled "staticInit"staticInit(): void