[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'FileCtrl' (#lcl)

TCustomFilterComboBox.ConvertFilterToStrings

Parses the file filter(s) in AFilter and stores them in AStrings.

Declaration

Source position: filectrl.pp line 163

public class procedure TCustomFilterComboBox.ConvertFilterToStrings(

  AFilter: string;

  AStrings: TStrings;

  AClearStrings: Boolean;

  AAddDescription: Boolean;

  AAddFilter: Boolean

);

Arguments

AFilter

  

Values converted in the method.

AStrings

  

TStrings instance where the filters are stored.

AClearStrings

  

Indicates if existing values in AStrings are cleared.

AAddDescription

  

True if the filter description is included in the converted values.

AAddFilter

  

True if the filter mask expression is included in the converted values.

Description

ConvertFilterToStrings is a class procedure used to parse the LCL filter string in AFilter, and store the individual filters in AStrings.

AFilter contains a value like: 'Text files (*.txt *.pas)|*.txt;*.pas|Binaries (*.exe)|*.exe'.

Values in AClearStrings, AAddDescription, and AAddFilter control the values stored in the AStrings.

AClearStrings indicates whether existing values in AStrings are cleared before adding values found in the method.

AAddDescription indicates if the descriptive text for file filter(s) are added to the string list.

AAddFilter indicates if the file mask portion of the filter is added to the string list.

When AAddDescription = True and AAddFilter = False, the following values would be stored in AStrings:

Text files (*.txt *.pas)
Binaries (*.exe)

Adapted from the converter initially created for QtWSDialogs.pas.


Version 4.0 Generated 2025-05-03 Home