Class
GridToolBarSearchBoxTool

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class GridToolBarSearchBoxTool : TableToolBarItem, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseTableToolBarItemGridToolBarSearchBoxTool

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members TableToolBarItem.OnInitializedAsync()TableToolBarItem.Dispose()TableToolBarItem.ToolBarComponentBase.OnInitialized()ComponentBase.OnParametersSetAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRender(bool)ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)

Constructors

GridToolBarSearchBoxTool()

Declaration

cs-api-definition
public GridToolBarSearchBoxTool()

Properties

Class

Custom CSS class(es) for the SearchBox root element. Use to apply styling that is not available through other built-in parameters.

Declaration

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

Property Value

string

DebounceDelay

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

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 columns are searchable by default.

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, Outline, or Flat for different visual appearances. When null (the default), the search box uses the theme's default fill mode.

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.

Declaration

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

Property Value

string

Rounded

Controls the corner radius of the search box. Use Small, Medium, Large, or Full for different border radius values. When null (the default), the search box uses the theme's default rounded value.

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. When null (the default), the search box uses the theme's default size.

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

BuildRenderTree(RenderTreeBuilder)

Declaration

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

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()