Class GridSearchSettings

Configures grid searching.

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

Constructors

GridSearchSettings()

Declaration
public GridSearchSettings()

Properties

Fields

Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.

Declaration
[Parameter]
public string[]? Fields { get; set; }
Property Value
Type
string[]

IgnoreAccent

If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.

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

Ignore accent is supported by remote data alone. IgnoreAccent key will be sent to server and operation should be handled at user level.

IgnoreCase

If IgnoreCase is set to false, searches records that match exactly, else searches records that are case insensitive(uppercase and lowercase letters treated the same).

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

Key

Specifies the key value to search Grid records at initial rendering. You can also get the current search key.

Declaration
[Parameter]
public string Key { get; set; }
Property Value
Type
string

Operator

Defines the operator to search records.

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

Methods

OnInitializedAsync()

Invoked during component initialization. Updates the parent grid with the current search settings and initializes internal state fields.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Invoked when component parameters are set or updated. Synchronizes search-related properties such as fields, case sensitivity, and operator settings, and notifies the parent component if any changes occur.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements