TdxSpreadSheetConditionalFormattingIconSetPresets.FindByIconIndex(Integer,TdxSpreadSheetConditionalFormattingIconSetPreset,Integer) Method

Searches an icon preset containing an icon with the specified index within the global conditional formatting icon list.

Declaration

function FindByIconIndex(const AIconIndex: Integer; out APreset: TdxSpreadSheetConditionalFormattingIconSetPreset; out AIndexInPreset: Integer): Boolean;

Parameters

Name	Type
AIconIndex	Integer
APreset	TdxSpreadSheetConditionalFormattingIconSetPreset
AIndexInPreset	Integer

Returns

Type
Boolean

Remarks

Call this function to obtain the first found icon preset that includes the icon whose index within the global list is passed as the AIconIndex parameter. The FindByIconIndex function iterates through all icon presets within the collection calling the IndexOf function for each preset to search the specified icon. When the first occurrence is found, the function returns both the found preset and the specified icon’s index within it as the APreset and AIndexInPreset out parameters, respectively. If no presets within the collection include the specified icon, the FindByIconIndex function returns False.

To search a specific icon preset within the collection by the specified icon count or preset identifier, call the FindByCount or FindByName function, respectively.