ExcelScript.ConditionalTextComparisonRule interface

Package:

ExcelScript

Represents a cell value conditional format rule.

Remarks

Examples

TypeScript

/**
 * This script adds conditional formatting to the first column in the worksheet.
 * This formatting gives the cells a green fill if they have text starting with "Excel".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first column in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const firstColumn = currentSheet.getRange("A:A");

  // Add conditional formatting based on the text in the cells.
  const textConditionFormat = 
    firstColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.containsText).getTextComparison();

  // Set the conditional format to provide a green fill.
  textConditionFormat.getFormat().getFill().setColor("green");

  // Apply the condition rule that the text begins with "Excel".
  const textRule: ExcelScript.ConditionalTextComparisonRule = {
    operator: ExcelScript.ConditionalTextOperator.beginsWith,
    text: "Excel"
  };
  textConditionFormat.setRule(textRule);
}

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: ConditionalTextOperator;

Property Value

ExcelScript.ConditionalTextOperator

text

The text value of the conditional format.

TypeScript

text: string;

Property Value

string