Column Menu
The column menu allows users to quickly access column-related operations like sorting and filtering.
To enable the column menu, use the ColumnMenu(true)
method. As a result, the column headers of the Grid render a column menu, which allows the user to sort, filter, or change the visibility of a column. The column menu also detects when a specific column operation is disabled through the column definition and excludes the corresponding UI from rendering. For a runnable example, refer to the demo on implementing a column menu in the Grid.
As of the R3 2022 release, you can disable the column menu for a specific column by using
.ColumnMenu(false)
.
Global Column Menu
As of Telerik UI for ASP.NET MVC R1 2024, you can display the column menu in the Grid's Toolbar instead of in each column's header. The global column menu allows you to control the columns' visibility and clear all filters applied to the Grid through a single button.
The following example shows how to set up the global column menu and enable the clear-all-filters button.
@(Html.Kendo().Grid<Kendo.Mvc.Examples.Models.OrderViewModel>()
.Name("grid")
.ToolBar(toolbar => toolbar.Columns())
.ColumnMenu(menu =>
{
menu.ClearAllFilters(true);
})
...
)
For a runnable example with the global column menu, see the Grid Global Column Menu demo.
Column Reordering
As of Telerik UI for ASP.NET MVC R2 SP1 2023, the Grid's Column Menu provides an option to change the position of the target column by using Move next and Move previous buttons. The functionality requires that reordering for the columns is enabled.
@(Html.Kendo().Grid<Kendo.Mvc.Examples.Models.OrderViewModel>()
.Name("grid")
.Reorderable(reorder => reorder.Columns(true))
)
To see this functionality in action, check the Grid Column Menu demo.
Column Grouping
As of Telerik UI for ASP.NET MVC R2 SP1 2023, the Grid's Column Menu provides an option that allows users to select the target column for grouping or ungrouping the Grid. To display the option item in the Column Menu, enable grouping via the Groupable
configuration.
Sort
The column menu allows you to control the visibility of each Grid column. For this purpose, the column menu renders a child column menu with a checkbox for each Grid column.
By default, the Grid column titles in the child column menu are not sorted. They have the same order as the columns in the Grid. To sort the column titles in the child menu, use the ColumnMenu()
method.
The below example demonstrates how to sort the column titles in the child menu in ascending order:
.ColumnMenu(menu=>
menu.Columns(columns => columns.Sort("asc"))
)
Group
The ColumnMenu()
method accepts a GridColumnMenuSettingsBuilder
that enables grouping of the columns in the child menu. The Columns()
group method expects a collection of the model properties. The menu will automatically use the title of the grid columns if such is defined
The following example demonstrates how to group columns by providing the model fields in a list of strings:
.ColumnMenu(menu=>
menu.Columns(columns => {
columns.Groups(groups =>
{
groups.Add().Title("Company Info").Columns(new List<string> { "CompanyName", "Country" }); ;
groups.Add().Title("Contact Info").Columns(new List<string> { "ContactName", "ContactTitle" });
});
})
)
Column Menu Types
The Telerik UI for ASP.NET MVC Grid provides the following Column Menu component types:
Column Menu Type | Description |
---|---|
classic |
The default rendering mode of the Grid's Column Menu |
modern |
Introduced with R1 2021 version of the Telerik UI for ASP.NET MVC suite. The modern rendering mode aims to deliver a fresh look and feel to the Grid's Column Menu |
tabbed |
Introduced with R3 SP1 2023 version of the Telerik UI for ASP.NET MVC suite. The tabbed component type delivers a more compact view without sacrificing the available space. The tabbed interface provides a neat way to organize items into related groups. |
By default, the column menu of the Grid is initialized in the classic
render mode. To set it to modern
or tabbed
, configure the ColumnMenu.ComponentType
option of the Telerik UI for ASP.NET MVC Grid as demonstrated below:
@(Html.Kendo().Grid()
.Name("datePicker")
.ColumnMenu(m=>{
m.ComponentType("tabbed");
})
)