Excel.ConditionalTextComparisonRule interface

Package:

excel

Represents a cell value conditional format rule.

Remarks

[ API set: ExcelApi 1.6 ]

Properties

operator	The operator of the text conditional format.
text	The text value of the conditional format.

Property Details

operator

The operator of the text conditional format.

TypeScript

operator: Excel.ConditionalTextOperator | "Invalid" | "Contains" | "NotContains" | "BeginsWith" | "EndsWith";

Property Value

Excel.ConditionalTextOperator | "Invalid" | "Contains" | "NotContains" | "BeginsWith" | "EndsWith"

Remarks

[ API set: ExcelApi 1.6 ]

text

The text value of the conditional format.

TypeScript

text: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.6 ]

Examples

TypeScript

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