ExcelScript.ConditionalRangeFormat interface

Package:

ExcelScript

A format object encapsulating the conditional formats range's font, fill, borders, and other properties.

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

getBorders()	Collection of border objects that apply to the overall conditional format range.
getConditionalRangeBorder(index)	Gets a border object using its name.
getConditionalRangeBorderBottom()	Gets the bottom border.
getConditionalRangeBorderLeft()	Gets the left border.
getConditionalRangeBorderRight()	Gets the right border.
getConditionalRangeBorderTop()	Gets the top border.
getFill()	Returns the fill object defined on the overall conditional format range.
getFont()	Returns the font object defined on the overall conditional format range.
getNumberFormat()	Represents Excel's number format code for the given range. Cleared if null is passed in.
setNumberFormat(numberFormat)	Represents Excel's number format code for the given range. Cleared if null is passed in.

Method Details

getBorders()

Collection of border objects that apply to the overall conditional format range.

getBorders(): ConditionalRangeBorder[];

Returns

ExcelScript.ConditionalRangeBorder[]

getConditionalRangeBorder(index)

Gets a border object using its name.

getConditionalRangeBorder(
            index: ConditionalRangeBorderIndex
        ): ConditionalRangeBorder;

Parameters

index

ExcelScript.ConditionalRangeBorderIndex

Index value of the border object to be retrieved. See ExcelScript.ConditionalRangeBorderIndex for details.

Returns

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderBottom()

Gets the bottom border.

getConditionalRangeBorderBottom(): ConditionalRangeBorder;

Returns

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderLeft()

Gets the left border.

getConditionalRangeBorderLeft(): ConditionalRangeBorder;

Returns

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderRight()

Gets the right border.

getConditionalRangeBorderRight(): ConditionalRangeBorder;

Returns

ExcelScript.ConditionalRangeBorder

getConditionalRangeBorderTop()

Gets the top border.

getConditionalRangeBorderTop(): ConditionalRangeBorder;

Returns

ExcelScript.ConditionalRangeBorder

getFill()

Returns the fill object defined on the overall conditional format range.

getFill(): ConditionalRangeFill;

Returns

ExcelScript.ConditionalRangeFill

getFont()

Returns the font object defined on the overall conditional format range.

getFont(): ConditionalRangeFont;

Returns

ExcelScript.ConditionalRangeFont

getNumberFormat()

Represents Excel's number format code for the given range. Cleared if null is passed in.

getNumberFormat(): string;

Returns

string

setNumberFormat(numberFormat)

Represents Excel's number format code for the given range. Cleared if null is passed in.

setNumberFormat(numberFormat: string): void;

Parameters

numberFormat

string

Returns

void