Skip to content

TTMSFNCDataSetFilterDialog

The TTMSFNCDataSetFilterDialog is a dialog window used to format SQL-based filter text for Delphi DataSets. It provides an interactive way for users to construct filters using a graphical interface. This control allows seamless filtering of dataset records with customizable appearance and options.

TTMSFNCDataSetFilterDialog

Usage

Assign an active TDataSet to the DataSet property of the FilterDialog for the best outcome.

To show the dialog, call the Execute method.

procedure TForm1.Button1Click(Sender: TObject);
begin
  TTMSFNCDataSetFilterDialog1.Execute;
end;
When you Apply, the assigned Dataset will automatically be set to filtered and the generated filter text will be applied.

Properties

Property name Description
FilterText: string Represents the SQL-based filter text generated by the dialog.
DataSet: TDataSet The dataset on which the filter will be applied.
Options: TTMSFNCFilterDialogOptions Configuration options for the filter dialog. The label settings for each text in the dialog.
Appearance: TTMSFNCFilterDialogAppearance Defines the visual appearance settings of the dialog.

Methods

Method name Description
Execute Shows the dialog.

Events

Event name Description
OnApplyButtonClicked Triggered when the Apply button is clicked.
OnCancelButtonClicked Triggered when the Cancel button is clicked.
OnClearButtonClicked Triggered when the Clear button is clicked.
OnClose Triggered when the dialog is closed.
OnGetFormatSettings Allows customization of format settings.
OnShowCustomEditor Triggered when the editor type was set to vetCustom in the OnShowExpressionEditor or OnShowGroupEditor event.
OnShowExpressionEditor Invoked when an expression editor is displayed.
OnShowGroupEditor Invoked when a group editor is displayed.