Class
TableSearchBox

The class for the SearchBox you can add in the toolbar.

Definition

Namespace:Telerik.Blazor.Components.Common.Grid.SearchBox

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition

public class TableSearchBox : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTableSearchBox

Derived Classes: GridSearchBoxTreeListSearchBox

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()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.BuildRenderTree(RenderTreeBuilder)ComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)

Constructors

TableSearchBox()

Declaration

cs-api-definition

public TableSearchBox()

Properties

DebounceDelay

Delay in milliseconds between when user stops typing and when search filtering is applied. Use this to prevent excessive filtering during typing. Default value is 300ms.

Declaration

cs-api-definition

[Parameter]
public int DebounceDelay { get; set; }

Property Value

int

Fields

List of column field names to include in search operations. When empty, all string-type fields are automatically included in search.

Declaration

cs-api-definition

[Parameter]
public IList<string> Fields { get; set; }

Property Value

IList<string>

FillMode

Controls the background styling of the search box. Use Solid for filled background, Outline for border-only, or Flat for minimal styling. Default value is Solid.

Declaration

cs-api-definition

[Parameter]
public string FillMode { get; set; }

Property Value

string

Placeholder

Text displayed inside the search box when it's empty. Use this to provide hints about search functionality to users. Default value is "Search" (localized).

Declaration

cs-api-definition

[Parameter]
public string Placeholder { get; set; }

Property Value

string

Rounded

Sets the corner radius of the search box. Use Small, Medium, Large, or Full for different border radius values. Default value is Medium.

Declaration

cs-api-definition

[Parameter]
public string Rounded { get; set; }

Property Value

string

Size

Controls the height and padding of the search box. Use Small, Medium, or Large for different sizes. Default value is Medium.

Declaration

cs-api-definition

[Parameter]
public string Size { get; set; }

Property Value

string

Width

CSS width value for the search box. Use pixels, percentages, or other CSS units to control the search box width.

Declaration

cs-api-definition

[Parameter]
public string Width { get; set; }

Property Value

string

Methods

Dispose()

Declaration

cs-api-definition

public override void Dispose()

Overrides BaseComponent.Dispose()

OnAfterRenderAsync(bool)

Declaration

cs-api-definition

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

ClassTableSearchBox

Class
TableSearchBox