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

GridColumnFilterableCellSettingsBuilder

Class

Provides a fluent interface for configuring Grid column filterable cell settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class GridColumnFilterableCellSettingsBuilder

Inheritance: objectGridColumnFilterableCellSettingsBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

GridColumnFilterableCellSettingsBuilder(GridColumnFilterableCellSettings, ViewContext, IUrlGenerator)

Initializes a new instance of the GridColumnFilterableCellSettings class.

public GridColumnFilterableCellSettingsBuilder(GridColumnFilterableCellSettings settings, ViewContext viewContext, IUrlGenerator urlGenerator)

Parameters:settingsGridColumnFilterableCellSettings

The settings.

viewContextViewContext

The ViewContext object

urlGeneratorIUrlGenerator

The IUrlGenerator generator.

Methods

BindTo(IEnumerable)

public GridColumnFilterableCellSettingsBuilder BindTo(IEnumerable dataSource)

Parameters:dataSourceIEnumerableReturns:

GridColumnFilterableCellSettingsBuilder

DataSource(Action<ReadOnlyDataSourceBuilder>)

Configures the DataSource options.

public GridColumnFilterableCellSettingsBuilder DataSource(Action<ReadOnlyDataSourceBuilder> configurator)

Parameters:configuratorAction<ReadOnlyDataSourceBuilder>

The DataSource configurator action.

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt;
columns.Bound(o =&gt; o.OrderDate)
.Filterable(filterable =&gt;
filterable.Cell(cell =&gt;
cell.DataSource(ds =&gt;
ds.Read("someAction", "someController")
)
)
)
))

DataTextField(string)

Specifies the name of the field which will be used to show the suggestions when using Custom DataSource.

public GridColumnFilterableCellSettingsBuilder DataTextField(string dataTextField)

Parameters:dataTextFieldstring

The dataTextField

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.DataTextField("FirstName")));
}))

Delay(double)

Specifies the delay of the AutoComplete suggestions when the column is of type string.

public GridColumnFilterableCellSettingsBuilder Delay(double delay)

Parameters:delaydouble

The delay value.

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.Delay(5)));
}))

Enabled(bool)

Specifying if the cell should be enabled.

public GridColumnFilterableCellSettingsBuilder Enabled(bool value)

Parameters:valuebool

If 'true' - encoded, otherwise not.

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.Enabled(true)));
}))

InputWidth(int)

Specifies the width of the input before it is turned into a widget.

public GridColumnFilterableCellSettingsBuilder InputWidth(int inputWidth)

Parameters:inputWidthint

The input width

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.InputWidth(5)));
}))

MinLength(int)

Specifies the MinLength option of the AutoComplete suggestions when the column is of type string.

public GridColumnFilterableCellSettingsBuilder MinLength(int minLength)

Parameters:minLengthint

The minimum length

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.MinLength(5)));
}))

Operator(string)

Specifies the default operator that will be used for the cell filtering.

public GridColumnFilterableCellSettingsBuilder Operator(string defaultOperator)

Parameters:defaultOperatorstring

Default operator.

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.Operator("neq")));
}))

ShowOperators(bool)

Specifies whether to show or hide the DropDownList with the operators.

public GridColumnFilterableCellSettingsBuilder ShowOperators(bool showOperators)

Parameters:showOperatorsbool

The value indicating if filter operator should be displayed

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.ShowOperators(true)));
}))

SuggestionOperator(FilterType)

Specifies the filter option of the AutoComplete suggestions when the column is of type string.

public GridColumnFilterableCellSettingsBuilder SuggestionOperator(FilterType filterType)

Parameters:filterTypeFilterType

The filter type

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.SuggestionOperator(FilterType.StartsWith)));
}))

Template(Func<object, object>)

Sets JavaScript function which to modify the UI of the filter input.

public GridColumnFilterableCellSettingsBuilder Template(Func<object, object> handler)

Parameters:handlerFunc<object, object>Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt;
columns.Bound(o =&gt; o.OrderDate)
.Filterable(filterable =&gt;
filterable.Cell(cell =&gt;
cell.Template(@&lt;text&gt;
JavaScript function goes here
&lt;/text&gt;)
)
)
))

Template(string)

Sets JavaScript function which to modify the filter input used for Row filtering.

public GridColumnFilterableCellSettingsBuilder Template(string handler)

Parameters:handlerstring

JavaScript function name

Returns:

GridColumnFilterableCellSettingsBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(x =&gt; x.Name).Filterable(ftb =&gt; ftb.Cell(c =&gt; c.Template("templateHandlerName")));
}))