Class
FilterField

Defines a filter field for the Filter component.

Definition

Constructors

FilterField()

Declaration

cs-api-definition
public FilterField()

Fields

_label

Declaration

cs-api-definition
public string _label

Field Value

string

Properties

DefaultOperator

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

Declaration

cs-api-definition
[Parameter]
public FilterOperator? DefaultOperator { get; set; }

Property Value

FilterOperator?

Label

Specifies displayed string for the given field.

Declaration

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

Property Value

string

Name

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

Declaration

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

Property Value

string

Operators

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

Declaration

cs-api-definition
[Parameter]
public List<FilterListOperator> Operators { get; set; }

Property Value

List<FilterListOperator>

Type

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

Declaration

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

Property Value

Type

ValueTemplate

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

Declaration

cs-api-definition
[Parameter]
public RenderFragment<FilterFieldValueTemplateContext> ValueTemplate { get; set; }

Property Value

RenderFragment<FilterFieldValueTemplateContext>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

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

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides ComponentBase.OnInitialized()

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

SetParametersAsync(ParameterView)

Declaration

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

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)