Edit

Excel.ConditionalCellValueRule interface

Package:
excel

Represents a cell value conditional format rule.

Remarks

API set: ExcelApi 1.6

Used by

Properties

formula1

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

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

The operator of the cell value conditional format.

Property Details

formula1

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

formula1: string;

Property Value

string

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

formula2

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

formula2?: string;

Property Value

string

Remarks

API set: ExcelApi 1.6

operator

The operator of the cell value conditional format.

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

Property Value

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

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