RadzenDataFilter<TItem> Class

RadzenDataFilter component.

Inheritance

Object

ComponentBase

RadzenComponent

RadzenDataFilter<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenDataFilter<TItem> : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender

Type Parameters

Name Description
TItemThe type of the item.

Constructors

RadzenDataFilter<TItem>Link to this section

RadzenDataFilter component.

Declaration
public RadzenDataFilter<TItem>()

Properties

AddFilterGroupTextLink to this section

Gets or sets the add filter group text.

Declaration
public string AddFilterGroupText { get; set; }
Property Value
Type Description
stringGets or sets the add filter group text.

AddFilterTextLink to this section

Gets or sets the add filter text.

Declaration
public string AddFilterText { get; set; }
Property Value
Type Description
stringGets or sets the add filter text.

AllowColumnFilteringLink to this section

Gets or sets a value indicating whether the columns can be filtered.

Declaration
public bool AllowColumnFiltering { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether the columns can be filtered.

AndOperatorTextLink to this section

Gets or sets the and operator text.

Declaration
public string AndOperatorText { get; set; }
Property Value
Type Description
stringGets or sets the and operator text.

ApplyFilterTextLink to this section

Gets or sets the apply filter text.

Declaration
public string ApplyFilterText { get; set; }
Property Value
Type Description
stringGets or sets the apply filter text.

AutoLink to this section

Gets or sets a value indicating whether this filter is automatic.

Declaration
public bool Auto { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether this filter is automatic.

ClearFilterTextLink to this section

Gets or sets the clear filter text.

Declaration
public string ClearFilterText { get; set; }
Property Value
Type Description
stringGets or sets the clear filter text.

ContainsTextLink to this section

Gets or sets the contains text.

Declaration
public string ContainsText { get; set; }
Property Value
Type Description
stringGets or sets the contains text.

CustomTextLink to this section

Gets or sets the custom filter operator text.

Declaration
public string CustomText { get; set; }
Property Value
Type Description
stringGets or sets the custom filter operator text.

DataLink to this section

Gets or sets the data.

Declaration
public IEnumerable<TItem> Data { get; set; }
Property Value
Type Description
IEnumerable<TItem>Gets or sets the data.

DoesNotContainTextLink to this section

Gets or sets the does not contain text.

Declaration
public string DoesNotContainText { get; set; }
Property Value
Type Description
stringGets or sets the does not contain text.

EndsWithTextLink to this section

Gets or sets the ends with text.

Declaration
public string EndsWithText { get; set; }
Property Value
Type Description
stringGets or sets the ends with text.

EnumFilterSelectTextLink to this section

Gets or sets the enum filter select text.

Declaration
public string EnumFilterSelectText { get; set; }
Property Value
Type Description
stringGets or sets the enum filter select text.

EqualsTextLink to this section

Gets or sets the equals text.

Declaration
public string EqualsText { get; set; }
Property Value
Type Description
stringGets or sets the equals text.

FilterCaseSensitivityLink to this section

Gets or sets the filter case sensitivity.

Declaration
public FilterCaseSensitivity FilterCaseSensitivity { get; set; }
Property Value
Type Description
FilterCaseSensitivityGets or sets the filter case sensitivity.

FilterDateFormatLink to this section

Gets or sets the filter date format.

Declaration
public string FilterDateFormat { get; set; }
Property Value
Type Description
stringGets or sets the filter date format.

FilterOperatorAriaLabelLink to this section

Gets or sets the aria-label of the filter operator dropdown.

Declaration
public string FilterOperatorAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the filter operator dropdown.

FilterTextLink to this section

Gets or sets the filter text.

Declaration
public string FilterText { get; set; }
Property Value
Type Description
stringGets or sets the filter text.

FilterValueAriaLabelLink to this section

Gets or sets the aria-label of the filter value editor.

Declaration
public string FilterValueAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the filter value editor.

FiltersLink to this section

Gets or sets the filters.

Declaration
public IEnumerable<CompositeFilterDescriptor> Filters { get; set; }
Property Value
Type Description
IEnumerable<CompositeFilterDescriptor>Gets or sets the filters.

GreaterThanOrEqualsTextLink to this section

Gets or sets the greater than or equals text.

Declaration
public string GreaterThanOrEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the greater than or equals text.

GreaterThanTextLink to this section

Gets or sets the greater than text.

Declaration
public string GreaterThanText { get; set; }
Property Value
Type Description
stringGets or sets the greater than text.

InTextLink to this section

Gets or sets the in operator text.

Declaration
public string InText { get; set; }
Property Value
Type Description
stringGets or sets the in operator text.

IsEmptyTextLink to this section

Gets or sets the is empty text.

Declaration
public string IsEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the is empty text.

IsNotEmptyTextLink to this section

Gets or sets the is not empty text.

Declaration
public string IsNotEmptyText { get; set; }
Property Value
Type Description
stringGets or sets the is not empty text.

IsNotNullTextLink to this section

Gets or sets the not null text.

Declaration
public string IsNotNullText { get; set; }
Property Value
Type Description
stringGets or sets the not null text.

IsNullTextLink to this section

Gets or sets the is null text.

Declaration
public string IsNullText { get; set; }
Property Value
Type Description
stringGets or sets the is null text.

LessThanOrEqualsTextLink to this section

Gets or sets the less than or equals text.

Declaration
public string LessThanOrEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the less than or equals text.

LessThanTextLink to this section

Gets or sets the less than text.

Declaration
public string LessThanText { get; set; }
Property Value
Type Description
stringGets or sets the less than text.

LogicalFilterOperatorLink to this section

Gets or sets the logical filter operator.

Declaration
public LogicalFilterOperator LogicalFilterOperator { get; set; }
Property Value
Type Description
LogicalFilterOperatorGets or sets the logical filter operator.

NotEqualsTextLink to this section

Gets or sets the not equals text.

Declaration
public string NotEqualsText { get; set; }
Property Value
Type Description
stringGets or sets the not equals text.

NotInTextLink to this section

Gets or sets the not in operator text.

Declaration
public string NotInText { get; set; }
Property Value
Type Description
stringGets or sets the not in operator text.

OrOperatorTextLink to this section

Gets or sets the or operator text.

Declaration
public string OrOperatorText { get; set; }
Property Value
Type Description
stringGets or sets the or operator text.

PropertiesLink to this section

Gets or sets the properties.

Declaration
public RenderFragment Properties { get; set; }
Property Value
Type Description
RenderFragmentGets or sets the properties.

PropertiesCollectionLink to this section

Gets the properties collection.

Declaration
public IList<RadzenDataFilterProperty<TItem>> PropertiesCollection { get; }
Property Value
Type Description
IList<RadzenDataFilterProperty<TItem>>Gets the properties collection.

PropertyAriaLabelLink to this section

Gets or sets the aria-label of the filter property dropdown.

Declaration
public string PropertyAriaLabel { get; set; }
Property Value
Type Description
stringGets or sets the aria-label of the filter property dropdown.

RemoveFilterTextLink to this section

Gets or sets the remove filter text.

Declaration
public string RemoveFilterText { get; set; }
Property Value
Type Description
stringGets or sets the remove filter text.

StartsWithTextLink to this section

Gets or sets the starts with text.

Declaration
public string StartsWithText { get; set; }
Property Value
Type Description
stringGets or sets the starts with text.

UniqueFiltersLink to this section

Gets or sets a value indicating whether properties can be reused in the filter.

Declaration
public bool UniqueFilters { get; set; }
Property Value
Type Description
boolGets or sets a value indicating whether properties can be reused in the filter.

ViewLink to this section

Gets the view.

Declaration
public IQueryable<TItem> View { get; }
Property Value
Type Description
IQueryable<TItem>Gets the view.

ViewChangedLink to this section

Gets or sets the view changed callback.

Declaration
public EventCallback<IQueryable<TItem>> ViewChanged { get; set; }
Property Value
Type Description
EventCallback<IQueryable<TItem>>Gets or sets the view changed callback.

Methods

AddFilterLink to this section

Add filter.

Declaration
public Task AddFilter(CompositeFilterDescriptor filter)
Parameters
Type Name Description
CompositeFilterDescriptor filter
Returns
Type Description
Task

BuildRenderTreeLink to this section

Declaration
protected override void BuildRenderTree(Rendering.RenderTreeBuilder __builder)
Parameters
Type Name Description
Rendering.RenderTreeBuilder __builder

ClearFiltersLink to this section

Clear filters.

Declaration
public Task ClearFilters()
Returns
Type Description
Task

FilterLink to this section

Recreates View using current Filters.

Declaration
public Task Filter()
Returns
Type Description
Task

GetComponentCssClassLink to this section

Declaration
protected override string GetComponentCssClass()
Returns
Type Description
string

RemoveFilterLink to this section

Remove filter.

Declaration
public Task RemoveFilter(CompositeFilterDescriptor filter)
Parameters
Type Name Description
CompositeFilterDescriptor filter
Returns
Type Description
Task
An error has occurred. This app may no longer respond until reloaded. Reload 🗙