Class RadzenDataFilter<TItem>

Namespace

Radzen.Blazor

Assembly

Radzen.Blazor.dll

RadzenDataFilter component.

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

Type Parameters

TItem

The type of the item.

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()

Extension Methods

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

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

Constructors

RadzenDataFilter()

public RadzenDataFilter()

Properties

AddFilterGroupText

Gets or sets the add filter group text.

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

Property Value

string

The add filter group text.

AddFilterText

Gets or sets the add filter text.

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

Property Value

string

The add filter text.

AllowColumnFiltering

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

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

Property Value

bool

true if columns can be filtered; otherwise, false.

AndOperatorText

Gets or sets the and operator text.

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

Property Value

string

The and operator text.

ApplyFilterText

Gets or sets the apply filter text.

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

Property Value

string

The apply filter text.

Auto

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

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

Property Value

bool

true if filter automatic; otherwise, false.

ClearFilterText

Gets or sets the clear filter text.

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

Property Value

string

The clear filter text.

ContainsText

Gets or sets the contains text.

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

Property Value

string

The contains text.

Data

Gets or sets the data.

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

Property Value

IEnumerable<TItem>

The data.

DoesNotContainText

Gets or sets the does not contain text.

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

Property Value

string

The does not contain text.

EndsWithText

Gets or sets the ends with text.

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

Property Value

string

The ends with text.

EnumFilterSelectText

Gets or sets the enum filter select text.

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

Property Value

string

The enum filter select text.

EqualsText

Gets or sets the equals text.

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

Property Value

string

The equals text.

FilterCaseSensitivity

Gets or sets the filter case sensitivity.

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

Property Value

FilterCaseSensitivity

The filter case sensitivity.

FilterDateFormat

Gets or sets the filter date format.

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

Property Value

string

The filter date format.

FilterText

Gets or sets the filter text.

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

Property Value

string

The filter text.

Filters

Gets or sets the filters.

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

Property Value

IEnumerable<CompositeFilterDescriptor>

The filters.

GreaterThanOrEqualsText

Gets or sets the greater than or equals text.

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

Property Value

string

The greater than or equals text.

GreaterThanText

Gets or sets the greater than text.

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

Property Value

string

The greater than text.

IsEmptyText

Gets or sets the is empty text.

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

Property Value

string

The empty text.

IsNotEmptyText

Gets or sets the is not empty text.

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

Property Value

string

The not empty text.

IsNotNullText

Gets or sets the not null text.

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

Property Value

string

The not null text.

IsNullText

Gets or sets the is null text.

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

Property Value

string

The null text.

LessThanOrEqualsText

Gets or sets the less than or equals text.

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

Property Value

string

The less than or equals text.

LessThanText

Gets or sets the less than text.

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

Property Value

string

The less than text.

LogicalFilterOperator

Gets or sets the logical filter operator.

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

Property Value

LogicalFilterOperator

The logical filter operator.

NotEqualsText

Gets or sets the not equals text.

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

Property Value

string

The not equals text.

OrOperatorText

Gets or sets the or operator text.

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

Property Value

string

The or operator text.

Properties

Gets or sets the properties.

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

Property Value

RenderFragment

The properties.

PropertiesCollection

Gets the properties collection.

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

Property Value

IList<RadzenDataFilterProperty<TItem>>

The properties collection.

RemoveFilterText

Gets or sets the remove filter text.

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

Property Value

string

The remove filter text.

StartsWithText

Gets or sets the starts with text.

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

Property Value

string

The starts with text.

UniqueFilters

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

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

Property Value

bool

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

View

Gets the view.

public virtual IQueryable<TItem> View { get; }

Property Value

IQueryable<TItem>

The view.

ViewChanged

Gets or sets the view changed callback.

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

Property Value

EventCallback<IQueryable<TItem>>

The view changed callback.

Methods

AddFilter(CompositeFilterDescriptor)

Add filter.

public Task AddFilter(CompositeFilterDescriptor filter)

Parameters

filter CompositeFilterDescriptor

Returns

Task

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClearFilters()

Clear filters.

public Task ClearFilters()

Returns

Task

Filter()

Recreates View using current Filters.

public Task Filter()

Returns

Task

GetComponentCssClass()

protected override string GetComponentCssClass()

Returns

string

RemoveFilter(CompositeFilterDescriptor)

Remove filter.

public Task RemoveFilter(CompositeFilterDescriptor filter)

Parameters

filter CompositeFilterDescriptor

Returns

Task