Class FilteredEventArgs

Provides information about the Filtered event.

Inheritance
System.Object
GridEventBaseArgs
FilteredEventArgs
FilteringEventArgs
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class FilteredEventArgs : GridEventBaseArgs

Constructors

FilteredEventArgs()

Declaration
public FilteredEventArgs()

Properties

ColumnName

Gets the Field name of the column that is currently associated with filtering action.

Declaration
public string ColumnName { get; }
Property Value
Type Description
System.String

The field name of the column that is currently associated with filtering, otherwise the value is null.

FilterPredicates

Gets the list of PredicateModel<T> objects containing filter predicate model details currently associated with filtering.

Declaration
public List<PredicateModel<object>> FilterPredicates { get; }
Property Value
Type Description
System.Collections.Generic.List<PredicateModel<System.Object>>

A list of PredicateModel<T> objects representing filter predicate model details currently associated with filtering.
Remarks

This property holds a collection of filter predicate values for a column currently undergoing filtering.

  • For filter types such as Excel or CheckBox, multiple predicate details are included from filtering using checkboxes and custom filters.
  • For filter types like Menu or FilterBar, only a single filter predicate detail is present. In essence, this property contains the current filter predicate details when a single or multiple values are filtered for a column. If the filter for a column is removed, the FilterPredicates property becomes null. To clear or reset filtering from all columns in the grid, use the ClearFilteringAsync() method, which results in both the FilterPredicates and ColumnName properties becoming null.