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

GridGroupingSettingsBuilder

Class

Defines the fluent interface for configuring GridGroupableSettings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class GridGroupingSettingsBuilder

Inheritance: objectGridGroupingSettingsBuilder

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

Methods

Enabled(bool)

Enables or disables filtering

public GridGroupingSettingsBuilder Enabled(bool value)

Parameters:valuebool

When set to false grouping is considered disabled.

Returns:

GridGroupingSettingsBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID);
columns.Bound(p =&gt; p.Freight);
})
.Groupable(g =&gt; g.Enabled(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Messages(Action<GroupingMessagesBuilder>)

Configures messages.

public GridGroupingSettingsBuilder Messages(Action<GroupingMessagesBuilder> configurator)

Parameters:configuratorAction<GroupingMessagesBuilder>

The lambda which configures text messages displayed during grouping.

Returns:

GridGroupingSettingsBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID);
columns.Bound(p =&gt; p.Freight);
})
.Groupable(g =&gt; g.Messages(m =&gt; m.Empty("Empty")))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

ShowFooter(bool)

Specifies whether the footer should be displayed when the Group is collapsed

public GridGroupingSettingsBuilder ShowFooter(bool value)

Parameters:valuebool

When enabled the group footer rows will remain visible when the corresponding group is collapsed.

Returns:

GridGroupingSettingsBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID);
columns.Bound(p =&gt; p.Freight);
})
.Groupable(g =&gt; g.ShowFooter(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Sort(Action<GridGroupableSortSettingsBuilder>)

Sets a sort configuration when grouping.

public GridGroupingSettingsBuilder Sort(Action<GridGroupableSortSettingsBuilder> configurator)

Parameters:configuratorAction<GridGroupableSortSettingsBuilder>

Sets the sort configuration when grouping.

Returns:

GridGroupingSettingsBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID);
columns.Bound(p =&gt; p.Freight);
})
.Groupable(g =&gt; g.Sort(s =&gt; s.Compare("compare")))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

When enabled the group footer rows will stick to the bottom of the scrollable content area while scrolling through the group's data rows. Requires the scrollable option to be enabled. The columns must have a groupFooterTemplate defined.

public GridGroupingSettingsBuilder StickyFooters(bool value)

Parameters:valuebool

The value for StickyFooters

Returns:

GridGroupingSettingsBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID);
columns.Bound(p =&gt; p.Freight);
})
.Groupable(g =&gt; g.StickyFooters(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

StickyHeaders(bool)

When enabled the group header rows will stick to the top of the scrollable content area while scrolling through the group's data rows. Requires the scrollable option to be enabled.

public GridGroupingSettingsBuilder StickyHeaders(bool value)

Parameters:valuebool

The value for StickyHeaders

Returns:

GridGroupingSettingsBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID);
columns.Bound(p =&gt; p.Freight);
})
.Groupable(g =&gt; g.StickyHeaders(true))
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

GridGroupingSettingsBuilder

Definition

Constructors