Class FilteringEventArgs

Event argument for filter/search operations triggered by user input in Syncfusion dropdowns—such as ComboBox, MultiSelect, or ListBox.

Inheritance
object
FilteringEventArgs
ComboBoxFilterEventArgs
Inherited Members
Namespace: Syncfusion.Blazor.DropDowns
Assembly: Syncfusion.Blazor.dll
Syntax
public class FilteringEventArgs
Remarks

FilteringEventArgs lets you implement custom filtering, cancel built-in logic, or capture the query for analytics in typeahead scenarios.

Examples
void OnFiltering(FilteringEventArgs args)
{
    if (args.Text is string filter && filter.Length < 2) args.Cancel = true;
    if (args.PreventDefaultAction) LogCustomFilter(filter);
}

Constructors

FilteringEventArgs()

Declaration
public FilteringEventArgs()

Properties

BaseEventArgs

[Obsolete] Legacy browser event for historic filtering API. Do not use.

Declaration
[Obsolete("This property is obsolete and no longer supported.", false)]
[JsonPropertyName("baseEventArgs")]
public object BaseEventArgs { get; }
Property Value
Type
object

Cancel

Gets or sets whether to cancel the current filter/search logic.

Declaration
[JsonPropertyName("cancel")]
public bool Cancel { get; set; }
Property Value
Type Description
bool

true cancels; false continues search/filter.

PreventDefaultAction

Gets or sets if the internal Syncfusion filter/search operation should be prevented (for custom filtering scenarios).

Declaration
[JsonPropertyName("preventDefaultAction")]
public bool PreventDefaultAction { get; set; }
Property Value
Type Description
bool

true disables internal filter, false to allow normal UI filtering.

Text

Gets the user-typed or filter text value in this event.

Declaration
[JsonPropertyName("text")]
public string Text { get; }
Property Value
Type Description
string

The filter term as string, or null if not provided.

UpdateData

[Obsolete] Old custom filtered data; not supported in new Syncfusion search scenarios.

Declaration
[Obsolete("This property is obsolete and no longer supported.", false)]
[JsonPropertyName("updateData")]
public object UpdateData { get; set; }
Property Value
Type
object