ExcelScript.ConditionalRangeFormat interface

Remarks

Examples

/**
 * This script applies cell value conditional formatting to a range.
 * Any value less than 60 will have the cell's fill color changed and the font made italic.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range to format.
  const selectedRange = workbook.getSelectedRange();

  // Add cell value conditional formatting.
  const cellValueConditionalFormatting =
    selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.cellValue).getCellValue();

  // Create the condition, in this case when the cell value is less than 60.
  const rule: ExcelScript.ConditionalCellValueRule = {
    formula1: "60",
    operator: ExcelScript.ConditionalCellValueOperator.lessThan
  };
  cellValueConditionalFormatting.setRule(rule);

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

Methods

Method Details

getBorders()

getBorders(): ConditionalRangeBorder[];

getConditionalRangeBorder(index)

getConditionalRangeBorder(
            index: ConditionalRangeBorderIndex
        ): ConditionalRangeBorder;

getConditionalRangeBorderBottom()

getConditionalRangeBorderBottom(): ConditionalRangeBorder;

getConditionalRangeBorderLeft()

getConditionalRangeBorderLeft(): ConditionalRangeBorder;

getConditionalRangeBorderRight()

getConditionalRangeBorderRight(): ConditionalRangeBorder;

getConditionalRangeBorderTop()

getConditionalRangeBorderTop(): ConditionalRangeBorder;

getFill()

getFill(): ConditionalRangeFill;

getFont()

getFont(): ConditionalRangeFont;

getNumberFormat()

getNumberFormat(): string;

setNumberFormat(numberFormat)

setNumberFormat(numberFormat: string): void;