Class GridFindSettings

Represents configuration settings for the Grid Find and Highlight feature.

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

Configure the behavior and appearance of the Find and Highlight feature, including placeholder text, match highlighting, and case-sensitivity options. These settings are applied when the Find toolbar item is enabled.

Constructors

GridFindSettings()

Declaration
public GridFindSettings()

Properties

CaseSensitive

Gets or sets a value indicating whether Find and Highlight matching is case-sensitive.

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

true to perform case-sensitive matching; otherwise, false. The default value is false.
Remarks

When set to false, values such as "John", "john", and "JOHN" are treated as matching text.

When set to true, only text with identical letter casing is matched.

HighlightCssClass

Gets or sets the CSS class applied to highlighted matches.

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

The CSS class name applied to highlighted matches. The default value is "e-find-highlight".
Remarks

Provide a custom CSS class to modify the appearance of highlighted matches. The specified CSS class is applied to the HTML mark element that wraps matched text.

PlaceholderText

Gets or sets the placeholder text displayed in the Find input field.

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

The placeholder text displayed when the input field is empty. The default value is "Find".
Remarks

Use this property to provide custom instructional text for the Find and Highlight input field.

Methods

OnInitializedAsync()

Invoked during component initialization. Updates the parent grid with the current find 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 find-related properties and notifies the parent component if any changes occur.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements