Excel.ConditionalCellValueRule interface

The formula, if required, on which to evaluate the conditional format rule.

formula1: string;

Property Value

Remarks

API set: ExcelApi 1.6

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();
});

The formula, if required, on which to evaluate the conditional format rule.

formula2?: string;

Property Value

Remarks

API set: ExcelApi 1.6

The operator of the cell value conditional format.

operator: Excel.ConditionalCellValueOperator | "Invalid" | "Between" | "NotBetween" | "EqualTo" | "NotEqualTo" | "GreaterThan" | "LessThan" | "GreaterThanOrEqual" | "LessThanOrEqual";

Property Value

Remarks

API set: ExcelApi 1.6

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();
});