ExcelScript.ConditionalCellValueRule interface

Package:

ExcelScript

Represents a cell value conditional format rule.

Remarks

Examples

/**
 * This script applies conditional formatting to a range.
 * That formatting is conditional upon the cell's numerical value.
 * Any value between 50 and 75 will have the cell fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const sheet = workbook.getActiveWorksheet();
  const ratingColumn = sheet.getRange("D2:D20");

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    ratingColumn.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();
  
  // Create the condition, in this case when the cell value is between 50 and 75.
  let rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "50",
    formula2: "75",
    operator: ExcelScript.ConditionalCellValueOperator.between
  };
  cellValueConditionalFormatting.setRule(rule);

  // Set the format to apply when the condition is met.
  let format = cellValueConditionalFormatting.getFormat();
  format.getFill().setColor("yellow");
  format.getFont().setItalic(true);
}

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

formula2

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

formula2?: string;

Property Value

string

operator

The operator of the cell value conditional format.

operator: ConditionalCellValueOperator;

Property Value

ExcelScript.ConditionalCellValueOperator