Class FilterDefinition<T>

Namespace

MudBlazor

Assembly

MudBlazor.dll

Represents the logic of a filter applied to MudGrid data.

public class FilterDefinition<T> : IFilterDefinition<T>

Type Parameters

T

The type of object being filtered.

Inheritance

object

FilterDefinition<T>

Implements

IFilterDefinition<T>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ObjectExtensions.As<T>(object?)

Constructors

FilterDefinition()

public FilterDefinition()

Properties

Column

The column for which this filter applies.

public Column<T>? Column { get; set; }

Property Value

Column<T>

FieldType

The type of column being filtered.

public FieldType FieldType { get; }

Property Value

FieldType

FilterFunction

The function which performs the filter.

public Func<T, bool>? FilterFunction { get; set; }

Property Value

Func<T, bool>

Id

The unique ID of this filter.

public Guid Id { get; set; }

Property Value

Guid

Operator

The kind of equality comparison to perform on values.

public string? Operator { get; set; }

Property Value

string

Remarks

Values typically come from FilterOperator depending on the data type:

FilterOperator.Boolean	Operators for bool column types.
FilterOperator.DateTime	Operators for DateTime column types.
FilterOperator.Enum	Operators for Enum column types.
FilterOperator.Guid	Operators for Guid column types.
FilterOperator.Number	Operators for numeric column types.
FilterOperator.String	Operators for string column types.

Title

The name of this filter.

public string? Title { get; set; }

Property Value

string

Value

The value to filter.

public object? Value { get; set; }

Property Value

object

Methods

Clone()

public IFilterDefinition<T> Clone()

Returns

IFilterDefinition<T>

GenerateFilterFunction(FilterOptions?)

Generates a function which performs the filter.

public Func<T, bool> GenerateFilterFunction(FilterOptions? filterOptions = null)

Parameters

filterOptions FilterOptions

Any options for generation, such as case sensitivity.

Returns

Func<T, bool>

A function which performs the filter.