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

GridBoundColumnFilterableBuilder

Class

Defines the fluent interface for configuring bound columns filterable options

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class GridBoundColumnFilterableBuilder : GridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>

Inheritance: objectGridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>GridBoundColumnFilterableBuilder

Inherited Members GridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>.Enabled(bool)GridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>.Operators(Action<FilterableOperatorsBuilder>)GridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>.Messages(Action<FilterableMessagesBuilder>)GridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>.Extra(bool)GridFilterableSettingsBuilderBase<GridBoundColumnFilterableBuilder>.Mode(GridFilterMode)object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

GridBoundColumnFilterableBuilder(GridBoundColumnFilterableSettings, ViewContext, IUrlGenerator)

Initializes a new instance of the GridBoundColumnFilterableBuilder class.

public GridBoundColumnFilterableBuilder(GridBoundColumnFilterableSettings settings, ViewContext viewContext, IUrlGenerator urlGenerator)

Parameters:settingsGridBoundColumnFilterableSettings

The settings.

viewContextViewContext

The ViewContext object

urlGeneratorIUrlGenerator

The IUrlGenerator generator.

Methods

BindTo(IEnumerable)

Provide IEnumerable that will be used as DataSource for Multi CheckBox filtering on this column

public GridBoundColumnFilterableBuilder BindTo(IEnumerable dataSource)

Parameters:dataSourceIEnumerable

Data of the DataSource

Returns:

GridBoundColumnFilterableBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Filterable()
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Filterable(ftb=&gt;ftb.Multi(true).BindTo(new object[] { new { Name = "Name1" }, new { Name = "Name2" } }));
}))

Cell(Action<GridColumnFilterableCellSettingsBuilder>)

Configures the column filter cell

public GridBoundColumnFilterableBuilder Cell(Action<GridColumnFilterableCellSettingsBuilder> configurator)

Parameters:configuratorAction<GridColumnFilterableCellSettingsBuilder>

The configuration of the cell.

Returns:

GridBoundColumnFilterableBuilder

Example:

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

CheckAll(bool)

Enables / disabled the CheckAll checkboxes when Multi Checkbox filtering is enabled.

public GridBoundColumnFilterableBuilder CheckAll(bool value)

Parameters:valueboolReturns:

GridBoundColumnFilterableBuilder

Example:

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

DataSource(Action<ReadOnlyDataSourceBuilder>)

Configures the DataSource options.

public GridBoundColumnFilterableBuilder DataSource(Action<ReadOnlyDataSourceBuilder> configurator)

Parameters:configuratorAction<ReadOnlyDataSourceBuilder>

The DataSource configurator action.

Returns:

GridBoundColumnFilterableBuilder

Example:

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

DataSource(string)

Sets the id/name of the used DataSource.

public GridBoundColumnFilterableBuilder DataSource(string DataSourceId)

Parameters:DataSourceIdstring

The DataSource object ID.

Returns:

GridBoundColumnFilterableBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Filterable()
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Filterable(ftb =&gt; ftb.DataSource("dataSourceId"));
}))

IgnoreCase(bool)

Toggles between case-insensitive (default) and case-sensitive searching.

public GridBoundColumnFilterableBuilder IgnoreCase(bool value)

Parameters:valuebool

If 'true' - ignore the case, otherwise - not.

Returns:

GridBoundColumnFilterableBuilder

Example:

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

ItemTemplate(string)

Sets the template for the checkbox rendering when Multi checkbox filtering is enabled

public GridBoundColumnFilterableBuilder ItemTemplate(string handler)

Parameters:handlerstring

The name of the handler that returns the template.

Returns:

GridBoundColumnFilterableBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Filterable(ftb=&gt;ftb.ItemTemplate("jsHandler"));
}))

Multi(bool)

Enables / disabled the Multi Checkbox filtering support for this column.

public GridBoundColumnFilterableBuilder Multi(bool value)

Parameters:valuebool

If 'true' - Multi Checkbox filtering is enabled, if 'false' Multi Checkbox filtering is disabled.

Returns:

GridBoundColumnFilterableBuilder

Example:

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

Search(bool)

Controls whether to show a search box when checkbox filtering is enabled.

public GridBoundColumnFilterableBuilder Search(bool value)

Parameters:valuebool

If 'true' - search is enabled, if 'false' search is disabled.

Returns:

GridBoundColumnFilterableBuilder

Example:

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

UI(Func<object, object>)

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

public GridBoundColumnFilterableBuilder UI(Func<object, object> handler)

Parameters:handlerFunc<object, object>Returns:

GridBoundColumnFilterableBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Filterable(ftb=&gt;ftb.UI(@&lt;text&gt;JavaScript function goes here&lt;/text&gt;));
}))

UI(GridFilterUIRole)

Sets the type of the input element of the filter menu

public GridBoundColumnFilterableBuilder UI(GridFilterUIRole role)

Parameters:roleGridFilterUIRole

The filter role.

Returns:

GridBoundColumnFilterableBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Filterable(ftb=&gt;ftb.UI(GridFilterUIRole.DatePicker));
}))

UI(string)

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

public GridBoundColumnFilterableBuilder UI(string handler)

Parameters:handlerstring

JavaScript function name

Returns:

GridBoundColumnFilterableBuilder

Example:

@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Filterable(ftb=&gt;ftb.UI("UIHandler"));
}))