Class
GridToolBarSmartBoxToolSearchSettings

Specifies settings.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class GridToolBarSmartBoxToolSearchSettings : GridToolBarSmartBoxToolSearchSettingsBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentGridToolBarSmartBoxToolSearchSettingsBaseGridToolBarSmartBoxToolSearchSettings

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members GridToolBarSmartBoxToolSearchSettingsBase.ChildContentGridToolBarSmartBoxToolSearchSettingsBase.EnabledBaseComponent.ShouldRender()BaseComponent.OnAfterRenderAsync(bool)BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)

Constructors

GridToolBarSmartBoxToolSearchSettings()

Declaration

cs-api-definition
public GridToolBarSmartBoxToolSearchSettings()

Properties

DebounceDelay

Specifies the delay in milliseconds before triggering a search after the user stops typing. Helps reduce the number of search operations during rapid typing, improving performance. Lower values (e.g., 100ms) provide faster feedback; higher values (e.g., 500ms) reduce server load. Defaults to 300 milliseconds, balancing responsiveness and performance.

Declaration

cs-api-definition
[Parameter]
public int DebounceDelay { get; set; }

Property Value

int

Fields

Specifies which grid column fields to include in search operations. Provide field names as strings matching your data model property names (e.g., "ProductName", "Category"). When empty (default), the SmartBox automatically includes all string-type fields in the search. Use this to limit searches to specific columns for better performance or more targeted results. Works with OnSearch event to perform the actual search logic.

Declaration

cs-api-definition
[Parameter]
public IList<string> Fields { get; set; }

Property Value

IList<string>

OnSearch

Fires when the user performs a search operation in the Grid toolbar SmartBox. The event args (GridSmartBoxSearchEventArgs) contain the search query and allow you to cancel the default behavior. Use this to implement custom search logic, filter grid data, or integrate with external search services. Works with Fields to determine which columns to search and DebounceDelay to control timing.

Declaration

cs-api-definition
[Parameter]
public EventCallback<GridSmartBoxSearchEventArgs> OnSearch { get; set; }

Property Value

EventCallback<GridSmartBoxSearchEventArgs>

Placeholder

Defines the placeholder text displayed in the search input when empty. Provides guidance to users about what they can search for. Defaults to a localized search prompt. Example: "Search in all columns..." or "Enter search term".

Declaration

cs-api-definition
[Parameter]
public string Placeholder { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnInitializedAsync()

Declaration

cs-api-definition
protected override Task OnInitializedAsync()

Returns

Task

Overrides GridToolBarSmartBoxToolSearchSettingsBase.OnInitializedAsync()

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides GridToolBarSmartBoxToolSearchSettingsBase.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides GridToolBarSmartBoxToolSearchSettingsBase.SetParametersAsync(ParameterView)