Excel.ConditionalFormat class
An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.
- Extends
Remarks
Properties
| cell |
Returns the cell value conditional format properties if the current conditional format is a |
| cell |
Returns the cell value conditional format properties if the current conditional format is a |
| color |
Returns the color scale conditional format properties if the current conditional format is a |
| color |
Returns the color scale conditional format properties if the current conditional format is a |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| custom | Returns the custom conditional format properties if the current conditional format is a custom type. |
| custom |
Returns the custom conditional format properties if the current conditional format is a custom type. |
| data |
Returns the data bar properties if the current conditional format is a data bar. |
| data |
Returns the data bar properties if the current conditional format is a data bar. |
| icon |
Returns the icon set conditional format properties if the current conditional format is an |
| icon |
Returns the icon set conditional format properties if the current conditional format is an |
| id | The priority of the conditional format in the current |
| preset | Returns the preset criteria conditional format. See |
| preset |
Returns the preset criteria conditional format. See |
| priority | The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. |
| stop |
If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. Value is |
| text |
Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text". |
| text |
Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text". |
| top |
Returns the top/bottom conditional format properties if the current conditional format is a |
| top |
Returns the top/bottom conditional format properties if the current conditional format is a |
| type | A type of conditional format. Only one can be set at a time. |
Methods
| change |
Change the conditional format rule type to cell value. |
| change |
Change the conditional format rule type to color scale. |
| change |
Change the conditional format rule type to text comparison. |
| change |
Change the conditional format rule type to custom. |
| change |
Change the conditional format rule type to data bar. |
| change |
Change the conditional format rule type to icon set. |
| change |
Change the conditional format rule type to preset criteria. |
| change |
Change the conditional format rule type to top/bottom. |
| delete() | Deletes this conditional format. |
| get |
Returns the range the conditonal format is applied to. Throws an error if the conditional format is applied to multiple ranges. |
| get |
Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this method returns an object with its |
| get |
Returns the |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| set |
Set the ranges that the conditonal format rule is applied to. |
| toJSON() | Overrides the JavaScript |
Property Details
cellValue
Returns the cell value conditional format properties if the current conditional format is a CellValue type.
readonly cellValue: Excel.CellValueConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B21:E23");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.cellValue);
conditionalFormat.cellValue.format.font.color = "red";
conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" };
await context.sync();
});
cellValueOrNullObject
Returns the cell value conditional format properties if the current conditional format is a CellValue type.
readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;Property Value
Remarks
colorScale
Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
readonly colorScale: Excel.ColorScaleConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:M5");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.colorScale);
const criteria = {
minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
};
conditionalFormat.colorScale.criteria = criteria;
await context.sync();
});
colorScaleOrNullObject
Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;Property Value
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
custom
Returns the custom conditional format properties if the current conditional format is a custom type.
readonly custom: Excel.CustomConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)';
conditionalFormat.custom.format.font.color = "green";
await context.sync();
});
customOrNullObject
Returns the custom conditional format properties if the current conditional format is a custom type.
readonly customOrNullObject: Excel.CustomConditionalFormat;Property Value
Remarks
dataBar
Returns the data bar properties if the current conditional format is a data bar.
readonly dataBar: Excel.DataBarConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.dataBar);
conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;
await context.sync();
});
dataBarOrNullObject
Returns the data bar properties if the current conditional format is a data bar.
readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;Property Value
Remarks
iconSet
Returns the icon set conditional format properties if the current conditional format is an IconSet type.
readonly iconSet: Excel.IconSetConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.iconSet);
const iconSetCF = conditionalFormat.iconSet;
iconSetCF.style = Excel.IconSet.threeTriangles;
/*
The iconSetCF.criteria array is automatically prepopulated with
criterion elements whose properties have been given default settings.
You can't write to each property of a criterion directly. Instead,
replace the whole criteria object.
With a "three*" icon set style, such as "threeTriangles", the third
element in the criteria array (criteria[2]) defines the "top" icon;
e.g., a green triangle. The second (criteria[1]) defines the "middle"
icon. The first (criteria[0]) defines the "low" icon, but it
can often be left empty as the following object shows, because every
cell that does not match the other two criteria always gets the low
icon.
*/
iconSetCF.criteria = [
{} as any,
{
type: Excel.ConditionalFormatIconRuleType.number,
operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
formula: "=700"
},
{
type: Excel.ConditionalFormatIconRuleType.number,
operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
formula: "=1000",
}
];
await context.sync();
});
iconSetOrNullObject
Returns the icon set conditional format properties if the current conditional format is an IconSet type.
readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;Property Value
Remarks
id
The priority of the conditional format in the current ConditionalFormatCollection.
readonly id: string;Property Value
string
Remarks
preset
Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
readonly preset: Excel.PresetCriteriaConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:M5");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.presetCriteria);
conditionalFormat.preset.format.font.color = "white";
conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage };
await context.sync();
});
presetOrNullObject
Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;Property Value
Remarks
priority
The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. Use a negative priority to begin from the back. Priorities greater than the bounds will get and set to the maximum (or minimum if negative) priority. Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it.
priority: number;Property Value
number
Remarks
stopIfTrue
If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. Value is null on data bars, icon sets, and color scales as there's no concept of StopIfTrue for these.
stopIfTrue: boolean;Property Value
boolean
Remarks
textComparison
Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text".
readonly textComparison: Excel.TextConditionalFormat;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B16:D18");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.containsText);
conditionalFormat.textComparison.format.font.color = "red";
conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" };
await context.sync();
});
textComparisonOrNullObject
Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text".
readonly textComparisonOrNullObject: Excel.TextConditionalFormat;Property Value
Remarks
topBottom
Returns the top/bottom conditional format properties if the current conditional format is a TopBottom type. For example, to format the top 10% or bottom 10 items.
readonly topBottom: Excel.TopBottomConditionalFormat;Property Value
Remarks
topBottomOrNullObject
Returns the top/bottom conditional format properties if the current conditional format is a TopBottom type. For example, to format the top 10% or bottom 10 items.
readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;Property Value
Remarks
type
A type of conditional format. Only one can be set at a time.
readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";Property Value
Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const worksheetRange = sheet.getRange();
worksheetRange.conditionalFormats.load("type");
await context.sync();
let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
worksheetRange.conditionalFormats.items.forEach(item => {
cfRangePairs.push({
cf: item,
range: item.getRange().load("address")
});
});
await context.sync();
if (cfRangePairs.length > 0) {
cfRangePairs.forEach(item => {
console.log(item.cf.type);
});
} else {
console.log("No conditional formats applied.");
}
});
Method Details
changeRuleToCellValue(properties)
Change the conditional format rule type to cell value.
changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;Parameters
- properties
- Excel.ConditionalCellValueRule
The properties to set for the cell value conditional format rule.
Returns
void
Remarks
changeRuleToColorScale()
Change the conditional format rule type to color scale.
changeRuleToColorScale(): void;Returns
void
Remarks
changeRuleToContainsText(properties)
Change the conditional format rule type to text comparison.
changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;Parameters
- properties
- Excel.ConditionalTextComparisonRule
The properties to set for the text comparison conditional format rule.
Returns
void
Remarks
changeRuleToCustom(formula)
Change the conditional format rule type to custom.
changeRuleToCustom(formula: string): void;Parameters
- formula
-
string
The formula to set for the custom conditional format rule.
Returns
void
Remarks
changeRuleToDataBar()
Change the conditional format rule type to data bar.
changeRuleToDataBar(): void;Returns
void
Remarks
changeRuleToIconSet()
Change the conditional format rule type to icon set.
changeRuleToIconSet(): void;Returns
void
Remarks
changeRuleToPresetCriteria(properties)
Change the conditional format rule type to preset criteria.
changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;Parameters
- properties
- Excel.ConditionalPresetCriteriaRule
The properties to set for the preset criteria conditional format rule.
Returns
void
Remarks
changeRuleToTopBottom(properties)
Change the conditional format rule type to top/bottom.
changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;Parameters
- properties
- Excel.ConditionalTopBottomRule
The properties to set for the top/bottom conditional format rule.
Returns
void
Remarks
delete()
getRange()
Returns the range the conditonal format is applied to. Throws an error if the conditional format is applied to multiple ranges.
getRange(): Excel.Range;Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const worksheetRange = sheet.getRange();
worksheetRange.conditionalFormats.load("type");
await context.sync();
let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
worksheetRange.conditionalFormats.items.forEach(item => {
cfRangePairs.push({
cf: item,
range: item.getRange().load("address")
});
});
await context.sync();
if (cfRangePairs.length > 0) {
cfRangePairs.forEach(item => {
console.log(item.cf.type);
});
} else {
console.log("No conditional formats applied.");
}
});
getRangeOrNullObject()
Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getRangeOrNullObject(): Excel.Range;Returns
Remarks
getRanges()
Returns the RangeAreas, comprising one or more rectangular ranges, to which the conditonal format is applied.
getRanges(): Excel.RangeAreas;Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.ConditionalFormat;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ConditionalFormat;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Excel.Interfaces.ConditionalFormatUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.ConditionalFormat): void;Parameters
- properties
- Excel.ConditionalFormat
Returns
void
setRanges(ranges)
Set the ranges that the conditonal format rule is applied to.
setRanges(ranges: Range | RangeAreas | string): void;Parameters
- ranges
-
Excel.Range | Excel.RangeAreas | string
Collection of one or more ranges for this rule to be applied to.
Returns
void
Remarks
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalFormatData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.ConditionalFormatData;Returns
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for