Skip to main content

TdxSpreadSheetConditionalFormattingIconSetPresets.Add(string,string,Integer[]) Method

Creates a new icon preset and appends it to the collection.

Declaration

function Add(const AName: string; const ADescription: string; AIndexes: array of Integer): Integer;

Parameters

Name Type
AName string
ADescription string
AIndexes Integer

Returns

Type
Integer

Remarks

Call this function to create a custom icon preset from the predefined image list accessible via the global conditional formatting icon storage‘s Icons property. The Add function creates a preset from icons whose indexes within the source list are passed as the AIndexes parameter and returns the preset’s index within the collection. To assign a descriptive name and internal identifier to a newly created preset, use the ADescription and AName parameters whose values initialize the preset’s Description and Name properties, respectively.

The global conditional formatting icon storage’s constructor calls the Add function internally to populate the collection with predefined icon presets.

See Also