HotXLS Docs

AddCondFormatIconSet method

Adds an Excel 2007+ Icon Set conditional formatting rule over a cell range, returning the new TCondFormatRule. Each cell receives one of the 3, 4, or 5 icons in the selected family, based on where its value falls in the auto-computed percentile thresholds. (Available since v2.34.0.)

Syntax

function AddCondFormatIconSet(const ARange: WideString;
  ASetType: TXLSIconSetType): TCondFormatRule;
ARange WideString. Sqref string, e.g. 'A1:A10'.
ASetType TXLSIconSetType. One of the 17 baseline Excel 2007 icon families — icsArrows3 / icsArrows3Gray / icsFlags3 / icsTrafficLights3 / icsTrafficLightsRimmed3 / icsSigns3 / icsSymbols3 / icsSymbolsUncircled3 / icsArrows4 / icsArrows4Gray / icsRedToBlack4 / icsRatings4 / icsTrafficLights4 / icsArrows5 / icsArrows5Gray / icsRatings5 / icsQuarters5. See TXLSIconSetType.

Remarks

The default thresholds split the value range into equal percentile slices (3 icons → 0/33/67, 4 icons → 0/25/50/75, 5 icons → 0/20/40/60/80). Use the returned TCondFormatRule.IconSet to override individual thresholds via SetThreshold, or to set Reverse / ShowOnly.

Example

This example puts the "3 Arrows (Colored)" icon set over A1:A10.

Sheet.AddCondFormatIconSet('A1:A10', icsArrows3);

See also