New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

FilterBuilder<T>

Class

Defines the fluent API for configuring the Kendo Filter for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

Syntax:

public class FilterBuilder<T> : WidgetBuilderBase<Filter<T>, FilterBuilder<T>>, IHtmlString where T : class

Inheritance: objectWidgetBuilderBase<Filter<T>, FilterBuilder<T>>FilterBuilder<T>

Implements: IHtmlString

Constructors

FilterBuilder(Filter<T>)

Initializes a new instance of the Filter class.

public FilterBuilder(Filter<T> component)

Parameters:componentFilter<T>

The component.

Methods

ApplyButton()

If set to true the filter will display a button which when clicked will apply filtering over the datasource.

public FilterBuilder<T> ApplyButton()

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.ApplyButton()
)

ApplyButton(bool)

If set to true the filter will display a button which when clicked will apply filtering over the datasource.

public FilterBuilder<T> ApplyButton(bool value)

Parameters:valuebool

The value that configures the applybutton.

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.ApplyButton()
)

DataSource(string)

The data source to which the widget will apply a filter. Should be an existing kendo.data.DataSource instance.

public FilterBuilder<T> DataSource(string value)

Parameters:valuestring

The value for DataSource

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(product =&gt; product.ProductName).Label("ProductName");
})
.DataSource("filterDataSource")
)

Events(Action<FilterEventBuilder>)

public FilterBuilder<T> Events(Action<FilterEventBuilder> configurator)

Parameters:configuratorAction<FilterEventBuilder>Returns:

FilterBuilder<T>

ExpressionPreview()

If set to true the filter will visualize the filter expression that will be applied to the datasource.

public FilterBuilder<T> ExpressionPreview()

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.ExpressionPreview()
)

ExpressionPreview(bool)

If set to true the filter will visualize the filter expression that will be applied to the datasource.

public FilterBuilder<T> ExpressionPreview(bool value)

Parameters:valuebool

The value that configures the expressionpreview.

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.ExpressionPreview()
)

Fields(Action<FilterFieldFactory<T>>)

The configuration of the filter fields. An array of JavaScript objects that hold information regarding the filter field, it's editor, default values used for filter and etc.

public FilterBuilder<T> Fields(Action<FilterFieldFactory<T>> configurator)

Parameters:configuratorAction<FilterFieldFactory<T>>

The configurator for the fields setting.

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(product =&gt; product.ProductName).Label("ProductName");
})
)

FilterExpression(Action<DataSourceFilterDescriptorFactory<T>>)

An object which represents a filter expression which the kendo.data.DataSource can use to filter the data.

public FilterBuilder<T> FilterExpression(Action<DataSourceFilterDescriptorFactory<T>> configurator)

Parameters:configuratorAction<DataSourceFilterDescriptorFactory<T>>Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(product =&gt; product.ProductName).Label("ProductName");
})
.FilterExpression(filter =&gt;
{
filter.Add(p =&gt; p.ProductName).IsGreaterThanOrEqualTo(5);
})
)

FilterExpression(CompositeFilterDescriptor)

An object which represents a filter expression which the kendo.data.DataSource can use to filter the data.

public FilterBuilder<T> FilterExpression(CompositeFilterDescriptor value)

Parameters:valueCompositeFilterDescriptor

The value for Expression

Returns:

FilterBuilder<T>

Example:

@{

FilterDescriptor filterDescriptor = FilterDescriptor()
{
Member = "ProductName",
CaseSensitiveFilter = true,
Value = "Chai",
MemberType = typeof(string),
Operator = FilterOperator.IsEqualTo
};

CompositeFilterDescriptor compositeFilterDescriptor = new CompositeFilterDescriptor()
{
FilterDescriptors = new FilterDescriptorCollection
{
filterDescriptor
},
CaseSensitiveFilter = true,
LogicalOperator = FilterCompositionLogicalOperator.Or
};
}


@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(product =&gt; product.ProductName).Label("ProductName");
})
.FilterExpression(@compositeFilterDescriptor)
)

MainLogic(FilterCompositionLogicalOperator)

Defines the value of the logical operator at the root level of the filter expression.

public FilterBuilder<T> MainLogic(FilterCompositionLogicalOperator value)

Parameters:valueFilterCompositionLogicalOperator

The value that configures the mainlogic.

Returns:

FilterBuilder<T>

Messages(Action<FilterMessagesSettingsBuilder<T>>)

public FilterBuilder<T> Messages(Action<FilterMessagesSettingsBuilder<T>> configurator)

Parameters:configuratorAction<FilterMessagesSettingsBuilder<T>>Returns:

FilterBuilder<T>

Operators(Action<FilterOperatorsSettingsBuilder>)

The text of the filter operators displayed in the filter.

public FilterBuilder<T> Operators(Action<FilterOperatorsSettingsBuilder> configurator)

Parameters:configuratorAction<FilterOperatorsSettingsBuilder>

The configurator for the operators setting.

Returns:

FilterBuilder<T>

Example:

@(Html.Kendo().Filter&lt;ProductViewModel&gt;()
.Name("filter")
.Fields(fields =&gt;
{
fields.Add(field =&gt; field.ProductName).Label("ProductName");
})
.Operators(operators =&gt;
{
operators.String(s =&gt;
{
s.Contains("Contains")
.Startswith("Starts with")
.Endswith("Ends with")
.Eq("Equals")
.Neq("Does not equal")
.Isnull("Is null")
.Isnotnull("Is not null")
.Isnotempty("Is not empty")
.Isnullorempty("Is null or empty")
.Isnotnullorempty("Is not null or empty")
.Contains("Contains")
.Doesnotcontain("Does not contain");
}
);
})
.FilterExpression(filter =&gt;
{
filter.Add(field =&gt; field.ProductName).Contains("Cha");
})
)