Class RadzenDataFilter<TItem>

RadzenDataFilter component.

Inheritance

object

ComponentBase

RadzenComponent

RadzenDataFilter<TItem>

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(MouseEventArgs)

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, int)

RadzenComponent.OnInitialized()

RadzenComponent.SetParametersAsync(ParameterView)

RadzenComponent.OnAfterRenderAsync(bool)

RadzenComponent.RaiseContextMenu(MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Dispose()

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.Reference

RadzenComponent.CurrentStyle

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

[CascadingTypeParameter("TItem")]
public class RadzenDataFilter<TItem> : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Type Parameters

Name	Description
TItem	The type of the item.

Constructors

RadzenDataFilter()

RadzenDataFilter component.

Declaration

public RadzenDataFilter()

Properties

AddFilterGroupText

Gets or sets the add filter group text.

Declaration

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

Property Value

Type	Description
string	The add filter group text.

AddFilterText

Gets or sets the add filter text.

Declaration

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

Property Value

Type	Description
string	The add filter text.

AllowColumnFiltering

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

Declaration

[Parameter]
public bool AllowColumnFiltering { get; set; }

Property Value

Type	Description
bool	true if columns can be filtered; otherwise, false.

AndOperatorText

Gets or sets the and operator text.

Declaration

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

Property Value

Type	Description
string	The and operator text.

ApplyFilterText

Gets or sets the apply filter text.

Declaration

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

Property Value

Type	Description
string	The apply filter text.

Auto

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

Declaration

[Parameter]
public bool Auto { get; set; }

Property Value

Type	Description
bool	true if filter automatic; otherwise, false.

ClearFilterText

Gets or sets the clear filter text.

Declaration

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

Property Value

Type	Description
string	The clear filter text.

ContainsText

Gets or sets the contains text.

Declaration

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

Property Value

Type	Description
string	The contains text.

CustomText

Gets or sets the custom filter operator text.

Declaration

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

Property Value

Type	Description
string	The custom filter operator text.

Data

Gets or sets the data.

Declaration

[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

Type	Description
IEnumerable<TItem>	The data.

DoesNotContainText

Gets or sets the does not contain text.

Declaration

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

Property Value

Type	Description
string	The does not contain text.

EndsWithText

Gets or sets the ends with text.

Declaration

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

Property Value

Type	Description
string	The ends with text.

EnumFilterSelectText

Gets or sets the enum filter select text.

Declaration

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

Property Value

Type	Description
string	The enum filter select text.

EqualsText

Gets or sets the equals text.

Declaration

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

Property Value

Type	Description
string	The equals text.

FilterCaseSensitivity

Gets or sets the filter case sensitivity.

Declaration

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

Property Value

Type	Description
FilterCaseSensitivity	The filter case sensitivity.

FilterDateFormat

Gets or sets the filter date format.

Declaration

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

Property Value

Type	Description
string	The filter date format.

FilterText

Gets or sets the filter text.

Declaration

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

Property Value

Type	Description
string	The filter text.

Filters

Gets or sets the filters.

Declaration

public IEnumerable<CompositeFilterDescriptor> Filters { get; set; }

Property Value

Type	Description
IEnumerable<CompositeFilterDescriptor>	The filters.

GreaterThanOrEqualsText

Gets or sets the greater than or equals text.

Declaration

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

Property Value

Type	Description
string	The greater than or equals text.

GreaterThanText

Gets or sets the greater than text.

Declaration

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

Property Value

Type	Description
string	The greater than text.

InText

Gets or sets the in operator text.

Declaration

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

Property Value

Type	Description
string	The in operator text.

IsEmptyText

Gets or sets the is empty text.

Declaration

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

Property Value

Type	Description
string	The empty text.

IsNotEmptyText

Gets or sets the is not empty text.

Declaration

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

Property Value

Type	Description
string	The not empty text.

IsNotNullText

Gets or sets the not null text.

Declaration

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

Property Value

Type	Description
string	The not null text.

IsNullText

Gets or sets the is null text.

Declaration

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

Property Value

Type	Description
string	The null text.

LessThanOrEqualsText

Gets or sets the less than or equals text.

Declaration

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

Property Value

Type	Description
string	The less than or equals text.

LessThanText

Gets or sets the less than text.

Declaration

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

Property Value

Type	Description
string	The less than text.

LogicalFilterOperator

Gets or sets the logical filter operator.

Declaration

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

Property Value

Type	Description
LogicalFilterOperator	The logical filter operator.

NotEqualsText

Gets or sets the not equals text.

Declaration

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

Property Value

Type	Description
string	The not equals text.

NotInText

Gets or sets the not in operator text.

Declaration

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

Property Value

Type	Description
string	The not in operator text.

OrOperatorText

Gets or sets the or operator text.

Declaration

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

Property Value

Type	Description
string	The or operator text.

Properties

Gets or sets the properties.

Declaration

[Parameter]
public RenderFragment Properties { get; set; }

Property Value

Type	Description
RenderFragment	The properties.

PropertiesCollection

Gets the properties collection.

Declaration

public IList<RadzenDataFilterProperty<TItem>> PropertiesCollection { get; }

Property Value

Type	Description
IList<RadzenDataFilterProperty<TItem>>	The properties collection.

RemoveFilterText

Gets or sets the remove filter text.

Declaration

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

Property Value

Type	Description
string	The remove filter text.

StartsWithText

Gets or sets the starts with text.

Declaration

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

Property Value

Type	Description
string	The starts with text.

UniqueFilters

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

Declaration

[Parameter]
public bool UniqueFilters { get; set; }

Property Value

Type	Description
bool	true, if there is only one filter by property; otherwise false.

View

Gets the view.

Declaration

public virtual IQueryable<TItem> View { get; }

Property Value

Type	Description
IQueryable<TItem>	The view.

ViewChanged

Gets or sets the view changed callback.

Declaration

[Parameter]
public EventCallback<IQueryable<TItem>> ViewChanged { get; set; }

Property Value

Type	Description
EventCallback<IQueryable<TItem>>	The view changed callback.

Methods

AddFilter(CompositeFilterDescriptor)

Add filter.

Declaration

public Task AddFilter(CompositeFilterDescriptor filter)

Parameters

Type	Name	Description
CompositeFilterDescriptor	filter

Returns

Type	Description
Task

BuildRenderTree(RenderTreeBuilder)

RadzenDataFilter component.

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ClearFilters()

Clear filters.

Declaration

public Task ClearFilters()

Returns

Type	Description
Task

Filter()

Recreates View using current Filters.

Declaration

public Task Filter()

Returns

Type	Description
Task

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
string

Overrides

RadzenComponent.GetComponentCssClass()

RemoveFilter(CompositeFilterDescriptor)

Remove filter.

Declaration

public Task RemoveFilter(CompositeFilterDescriptor filter)

Parameters

Type	Name	Description
CompositeFilterDescriptor	filter

Returns

Type	Description
Task

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Extension Methods

QueryableExtension.ToFilterString<T>(RadzenDataFilter<T>)

QueryableExtension.ToODataFilterString<T>(RadzenDataFilter<T>)