FilterDialogBeforeOpenEvent
Represents the event triggered before the Excel filter dialog opens in the Data Grid component. Provides details about the filter dialog that is about to be displayed, including the column being filtered. Used to customize or cancel the filter dialog opening based on custom logic or validation.
Props
The following table outlines the props for the FilterDialogBeforeOpenEvent:
| Name | Type | Default | Description |
|---|---|---|---|
| action | string | ActionType | - | Indicates the type of action that triggered the filter dialog. Typically represents the filter dialog opening action for Excel-style filtering. Helps identify the context in which the dialog is being displayed. |
| cancel | boolean | false | Allows cancellation of the Excel filter dialog opening. When set to true, prevents the filter dialog from being displayed, useful for implementing custom validation, conditional access, or alternative filter UI logic. Typically used in event handlers to control filter dialog behavior. |
| columnName | string | - | Specifies the name of the column for which the Excel filter dialog is being opened. Identifies the field in the data source associated with the filter dialog. Used to determine which column's data will be available for filtering. |
| columnType | string | - | Specifies the data type of the column being filtered (e.g., 'string', 'number', 'date', 'boolean'). Determines the filtering capabilities and UI elements available in the Excel filter dialog. Used internally to render appropriate filter controls based on column type. |
| options | ExcelFilterArgs | - | Provides configuration options for the Excel filter dialog. Contains settings such as available filter values, search options, and UI customization. Used to customize the Excel filter dialog appearance and behavior before it opens. |