Skip to main content

TdxSpreadSheetConditionalFormattingIconSetPresets.FindByName(string,TdxSpreadSheetConditionalFormattingIconSetPreset) Method

Searches an icon preset within the collection by the specified name.

Declaration

function FindByName(const AName: string; out APreset: TdxSpreadSheetConditionalFormattingIconSetPreset): Boolean;

Parameters

Name Type
AName string
APreset TdxSpreadSheetConditionalFormattingIconSetPreset

Returns

Type
Boolean

Remarks

Call this function to obtain the first found icon preset whose name matches the string passed as the AName parameter. The FindByName function iterates through all icon presets within the collection comparing their Name property values to the specified name. When the first match is found, the function returns True and the found icon preset as the APreset out parameter. If there are no presets with the specified name within the collection, the FindByName function returns False.

To search an icon preset containing a specific number of icons or including a certain icon within the global conditional formatting icon list, call the FindByCount or FindByIconIndex function, respectively.

See Also