Class RadzenDataFilter<TItem>

RadzenDataFilter component.

Inheritance

System.Object

RadzenComponent

RadzenDataFilter<TItem>

Implements

IDisposable

Inherited Members

RadzenComponent.Attributes

RadzenComponent.Element

RadzenComponent.MouseEnter

RadzenComponent.MouseLeave

RadzenComponent.ContextMenu

RadzenComponent.Culture

RadzenComponent.DefaultCulture

RadzenComponent.OnMouseEnter()

RadzenComponent.OnMouseLeave()

RadzenComponent.OnContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.Style

RadzenComponent.Visible

RadzenComponent.GetCssClass()

RadzenComponent.GetId()

RadzenComponent.Debounce(Func<Task>, Int32)

RadzenComponent.UniqueID

RadzenComponent.JSRuntime

RadzenComponent.IsJSRuntimeAvailable

RadzenComponent.OnInitialized()

RadzenComponent.SetParametersAsync(ParameterView)

RadzenComponent.Reference

RadzenComponent.OnAfterRenderAsync(Boolean)

RadzenComponent.RaiseContextMenu(Microsoft.AspNetCore.Components.Web.MouseEventArgs)

RadzenComponent.RaiseMouseEnter()

RadzenComponent.RaiseMouseLeave()

RadzenComponent.Dispose()

RadzenComponent.CurrentStyle

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public class RadzenDataFilter<TItem> : RadzenComponent, IDisposable

Type Parameters

Name	Description
TItem	The type of the item.

Properties

AddFilterGroupText

Gets or sets the add filter group text.

Declaration

public string AddFilterGroupText { get; set; }

Property Value

Type	Description
System.String	The add filter group text.

AddFilterText

Gets or sets the add filter text.

Declaration

public string AddFilterText { get; set; }

Property Value

Type	Description
System.String	The add filter text.

AllowColumnFiltering

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

Declaration

public bool AllowColumnFiltering { get; set; }

Property Value

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

AndOperatorText

Gets or sets the and operator text.

Declaration

public string AndOperatorText { get; set; }

Property Value

Type	Description
System.String	The and operator text.

ApplyFilterText

Gets or sets the apply filter text.

Declaration

public string ApplyFilterText { get; set; }

Property Value

Type	Description
System.String	The apply filter text.

Auto

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

Declaration

public bool Auto { get; set; }

Property Value

Type	Description
System.Boolean	true if filter automatic; otherwise, false.

ClearFilterText

Gets or sets the clear filter text.

Declaration

public string ClearFilterText { get; set; }

Property Value

Type	Description
System.String	The clear filter text.

ContainsText

Gets or sets the contains text.

Declaration

public string ContainsText { get; set; }

Property Value

Type	Description
System.String	The contains text.

CustomText

Gets or sets the custom filter operator text.

Declaration

public string CustomText { get; set; }

Property Value

Type	Description
System.String	The custom filter operator text.

Data

Gets or sets the data.

Declaration

public IEnumerable<TItem> Data { get; set; }

Property Value

Type	Description
IEnumerable<TItem>	The data.

DoesNotContainText

Gets or sets the does not contain text.

Declaration

public string DoesNotContainText { get; set; }

Property Value

Type	Description
System.String	The does not contain text.

EndsWithText

Gets or sets the ends with text.

Declaration

public string EndsWithText { get; set; }

Property Value

Type	Description
System.String	The ends with text.

EnumFilterSelectText

Gets or sets the enum filter select text.

Declaration

public string EnumFilterSelectText { get; set; }

Property Value

Type	Description
System.String	The enum filter select text.

EqualsText

Gets or sets the equals text.

Declaration

public string EqualsText { get; set; }

Property Value

Type	Description
System.String	The equals text.

FilterCaseSensitivity

Gets or sets the filter case sensitivity.

Declaration

public FilterCaseSensitivity FilterCaseSensitivity { get; set; }

Property Value

Type	Description
FilterCaseSensitivity	The filter case sensitivity.

FilterDateFormat

Gets or sets the filter date format.

Declaration

public string FilterDateFormat { get; set; }

Property Value

Type	Description
System.String	The filter date format.

Filters

Gets or sets the filters.

Declaration

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

Property Value

Type	Description
IEnumerable<CompositeFilterDescriptor>	The filters.

FilterText

Gets or sets the filter text.

Declaration

public string FilterText { get; set; }

Property Value

Type	Description
System.String	The filter text.

GreaterThanOrEqualsText

Gets or sets the greater than or equals text.

Declaration

public string GreaterThanOrEqualsText { get; set; }

Property Value

Type	Description
System.String	The greater than or equals text.

GreaterThanText

Gets or sets the greater than text.

Declaration

public string GreaterThanText { get; set; }

Property Value

Type	Description
System.String	The greater than text.

InText

Gets or sets the in operator text.

Declaration

public string InText { get; set; }

Property Value

Type	Description
System.String	The in operator text.

IsEmptyText

Gets or sets the is empty text.

Declaration

public string IsEmptyText { get; set; }

Property Value

Type	Description
System.String	The empty text.

IsNotEmptyText

Gets or sets the is not empty text.

Declaration

public string IsNotEmptyText { get; set; }

Property Value

Type	Description
System.String	The not empty text.

IsNotNullText

Gets or sets the not null text.

Declaration

public string IsNotNullText { get; set; }

Property Value

Type	Description
System.String	The not null text.

IsNullText

Gets or sets the is null text.

Declaration

public string IsNullText { get; set; }

Property Value

Type	Description
System.String	The null text.

LessThanOrEqualsText

Gets or sets the less than or equals text.

Declaration

public string LessThanOrEqualsText { get; set; }

Property Value

Type	Description
System.String	The less than or equals text.

LessThanText

Gets or sets the less than text.

Declaration

public string LessThanText { get; set; }

Property Value

Type	Description
System.String	The less than text.

LogicalFilterOperator

Gets or sets the logical filter operator.

Declaration

public LogicalFilterOperator LogicalFilterOperator { get; set; }

Property Value

Type	Description
LogicalFilterOperator	The logical filter operator.

NotEqualsText

Gets or sets the not equals text.

Declaration

public string NotEqualsText { get; set; }

Property Value

Type	Description
System.String	The not equals text.

NotInText

Gets or sets the not in operator text.

Declaration

public string NotInText { get; set; }

Property Value

Type	Description
System.String	The not in operator text.

OrOperatorText

Gets or sets the or operator text.

Declaration

public string OrOperatorText { get; set; }

Property Value

Type	Description
System.String	The or operator text.

Properties

Gets or sets the properties.

Declaration

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

public string RemoveFilterText { get; set; }

Property Value

Type	Description
System.String	The remove filter text.

StartsWithText

Gets or sets the starts with text.

Declaration

public string StartsWithText { get; set; }

Property Value

Type	Description
System.String	The starts with text.

UniqueFilters

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

Declaration

public bool UniqueFilters { get; set; }

Property Value

Type	Description
System.Boolean	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

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 async Task AddFilter(CompositeFilterDescriptor filter)

Parameters

Type	Name	Description
CompositeFilterDescriptor	filter

Returns

Type	Description
Task

ClearFilters()

Clear filters.

Declaration

public async Task ClearFilters()

Returns

Type	Description
Task

Filter()

Recreates View using current Filters.

Declaration

public async Task Filter()

Returns

Type	Description
Task

GetComponentCssClass()

Gets the component CSS class.

Declaration

protected override string GetComponentCssClass()

Returns

Type	Description
System.String

Overrides

RadzenComponent.GetComponentCssClass()

RemoveFilter(CompositeFilterDescriptor)

Remove filter.

Declaration

public async Task RemoveFilter(CompositeFilterDescriptor filter)

Parameters

Type	Name	Description
CompositeFilterDescriptor	filter

Returns

Type	Description
Task

Implements

IDisposable

Extension Methods

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

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