Class GridFilterSettings

Configures grid filtering.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
GridFilterSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class GridFilterSettings : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

GridFilterSettings()

Declaration
public GridFilterSettings()

Properties

AllowTextWrap

Gets or sets a value indicating whether the text in the filter checkbox automatically wraps to the next line when it exceeds the width of the filter dialog.

Declaration
[Parameter]
public bool AllowTextWrap { get; set; }
Property Value
Type Description
bool

true to enable text wrapping; otherwise, false. The default is false.
Remarks

Text wrapping applies to both the CheckBox and Excel

Columns

Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.

Declaration
[Parameter]
public List<GridFilterColumn> Columns { get; set; }
Property Value
Type
List<GridFilterColumn>
Remarks

Use GridFilterColumn component to define filter criteria.

EnableCaseSensitivity

If EnableCaseSensitivity is set to true then searches grid records with exact match based on the filter operator. It will have no effect on number, boolean and Date fields.

Declaration
[Parameter]
public bool EnableCaseSensitivity { get; set; }
Property Value
Type
bool

ImmediateModeDelay

Defines the time delay (in milliseconds) in filtering records when the Immediate mode of filter bar is set.

Declaration
[Parameter]
public int ImmediateModeDelay { get; set; }
Property Value
Type
int

Mode

Defines the filter bar modes. The available options are.

  • OnEnterInitiate filter operation after Enter key is pressed.
  • ImmediateInitiate filter operation after certain time interval. By default time interval is 1500ms.
Declaration
[Parameter]
public FilterBarMode Mode { get; set; }
Property Value
Type
FilterBarMode

Operators

The Operators is used to override the default operators in filter menu. This should be defined by type wise (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.

Declaration
[Parameter]
public object Operators { get; set; }
Property Value
Type
object

ShowFilterBarStatus

Shows or hides the filtered status message on the pager.

Declaration
[Parameter]
public bool ShowFilterBarStatus { get; set; }
Property Value
Type
bool

Type

Defines options for filtering type. The available options are.

  • FilterBarDefault. Specifies the filter type as filter bar.
  • MenuSpecifies the filter type as menu.
  • CheckBoxSpecifies the filter type as check box.
  • ExcelSpecifies the filter type as excel.
Declaration
[Parameter]
public FilterType Type { get; set; }
Property Value
Type
FilterType

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements