ExcelScript.CellValueConditionalFormat interface

Package:

ExcelScript

Represents a cell value conditional format.

Remarks

Examples

TypeScript

/**
 * 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 : ExcelScript.CellValueConditionalFormat 
    = 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);
}

Methods

getFormat()	Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.
getRule()	Specifies the rule object on this conditional format.
setRule(rule)	Specifies the rule object on this conditional format.

Method Details

getFormat()

Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.

TypeScript

getFormat(): ConditionalRangeFormat;

Returns

ExcelScript.ConditionalRangeFormat

getRule()

Specifies the rule object on this conditional format.

TypeScript

getRule(): ConditionalCellValueRule;

Returns

ExcelScript.ConditionalCellValueRule

setRule(rule)

Specifies the rule object on this conditional format.

TypeScript

setRule(rule: ConditionalCellValueRule): void;

Parameters

rule

ExcelScript.ConditionalCellValueRule

Returns

void