New to Telerik UI for BlazorStart a free 30-day trial

A component that lets you build and edit composite filters from configured fields. Binds to Value (CompositeFilterDescriptor), renders fields from FilterFields, raises OnUpdate on change, and supports ARIA labeling via AriaLabel. Children: FilterFields.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

C#
public class TelerikFilter : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikFilter

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.InvokeVoidAsyncWithoutAwait(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.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)...

Constructors

C#
public TelerikFilter()

Methods

C#
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

C#
public override void Dispose()

Overrides: BaseComponent.Dispose()

C#
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

Updates the component and processes the latest Value.

C#
public void Rebind()

Properties

[Accessibility] Specifies the aria-label attribute of the component.

C#
[Parameter]
public string AriaLabel { get; set; }

Specifies whether the field selection DropDownList displays a filter input that lets users search through the available fields.

C#
[Parameter]
public bool FilterableFields { get; set; }

Specifies the debounce delay in milliseconds for the filter input in the field selection DropDownList when FilterableFields is enabled.

C#
[Parameter]
public int FilterableFieldsDebounceDelay { get; set; }

Specifies the filter operator for the field selection DropDownList when FilterableFields is enabled.

C#
[Parameter]
public StringFilterOperator FilterableFieldsOperator { get; set; }

Specifies the placeholder text for the filter input in the field selection DropDownList when FilterableFields is enabled.

C#
[Parameter]
public string FilterableFieldsPlaceholder { get; set; }

Specifies the filter fields container. Add FilterField tags within this fragment. Children: FilterField tags.

C#
[Parameter]
public RenderFragment FilterFields { get; set; }

Fires when the component value has changed.

C#
[Parameter]
public EventCallback OnUpdate { get; set; }

Specifies the Value of the Filter.

C#
[Parameter]
public CompositeFilterDescriptor Value { get; set; }