Apply Conditional Formatting

Conditional formatting is a feature that lets you apply formatting to cells based on specific conditions. You can set the conditional format on the TemplateSheet by using a worksheet to set the conditional format. When the report is generated, the range of conditional format may change with the cell. You can use theaddCellValueRule method of the ConditionalFormats class to add new conditional formatting rules.

Notes:

• Conditional formatting is applicable in the TemplateSheet, but its performance improves when you switch the ReportSheet to the DataEntryPreview render mode.

• If the cell where the conditional format is applied on the TemplateSheet is not an extended cell, the size of the present condition format in the report sheet range is not changed, but there may be some offset (the top left exists cell for expansion).

• If the cell where the conditional format is placed on the TemplateSheet is an extended cell, the size of the current conditional format in the report sheet range will vary, and the range will expand in the same manner as the template cell. There could also be some offset (the upper left cell for expansion).

The following code sample sets up a conditional formatting rule that applies a red color to a specific cell if its value is less than or equal to 15.

const cfs = templateSheet.conditionalFormats;

// Create a new Style.
const style = new GC.Spread.Sheets.Style();
style.foreColor = 'red';

// Define the Ranges.
const ranges = [new GC.Spread.Sheets.Range(2, 2, 1, 1)];

// Display the ForeColor as "red" if the value is less than or equal to 15.
cfs.addCellValueRule(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.lessThanOrEqualsTo, 15, 15, style, ranges);

The output of the above code will look like below.