ExcelScript.CustomConditionalFormat interface

Package:

ExcelScript

Represents a custom conditional format type.

Remarks

Examples

/**
 * This script applies a custom three-color conditional formatting to the selected range.
 * The three colors represent positive, negative, or no changes from the values in the previous column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected cells.
  let selectedRange = workbook.getSelectedRange();

  // Apply a rule for positive change from the previous column.
  let positiveChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  positiveChange.getCustom().getFormat().getFill().setColor("lightgreen");
  positiveChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}>${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);

  // Apply a rule for negative change from the previous column.
  let negativeChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  negativeChange.getCustom().getFormat().getFill().setColor("pink");
  negativeChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}<${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);

  // Apply a rule for no change from the previous column.
  let noChange = selectedRange.addConditionalFormat(ExcelScript.ConditionalFormatType.custom);
  noChange.getCustom().getFormat().getFill().setColor("lightyellow");
  noChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
}

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.

Method Details

getFormat()

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

getFormat(): ConditionalRangeFormat;

Returns

ExcelScript.ConditionalRangeFormat

getRule()

Specifies the Rule object on this conditional format.

getRule(): ConditionalFormatRule;

Returns

ExcelScript.ConditionalFormatRule