New to Telerik UI for Blazor? Start a free 30-day trial

FilterField

Class

Defines a filter field for the Filter component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

public class FilterField : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseFilterField

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members ComponentBase.OnInitializedAsync()ComponentBase.OnParametersSetAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRender(bool)ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)...

Constructors

FilterField()

public FilterField()

Fields

_label

string

public string _label

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

public void Dispose()

Implements: IDisposable.Dispose()

OnInitialized()

protected override void OnInitialized()

Overrides: ComponentBase.OnInitialized()

OnParametersSet()

protected override void OnParametersSet()

Overrides: ComponentBase.OnParametersSet()

SetParametersAsync(ParameterView)

Task

public override Task SetParametersAsync(ParameterView parameters)

Parameters:parametersParameterViewReturns:

Task

Overrides: ComponentBase.SetParametersAsync(ParameterView)

Properties

DefaultOperator

FilterOperator?

Specifies the default filter operator. If unassigned, the default operator will be set based on the data type. See FilterOperator.

[Parameter]
public FilterOperator? DefaultOperator { get; set; }

Label

string

Specifies displayed string for the given field.

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

Name

string

Specifies the name of the field which will be used within the filter descriptor.

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

Operators

List<FilterListOperator>

Specifies the available operators. If not defined, a default list of available operators will be used based on the field type. See FilterListOperator.

[Parameter]
public List<FilterListOperator> Operators { get; set; }

Type

Specifies the type of the field for the filtering, based on which an editor will be initialized.

[Parameter]
public Type Type { get; set; }

ValueTemplate

RenderFragment<FilterFieldValueTemplateContext>

The filter field value template. Use to override the default rendering of the filter field value.

[Parameter]
public RenderFragment<FilterFieldValueTemplateContext> ValueTemplate { get; set; }