Toolbar
The ToolBar() configuration option of the Grid allows you to add command buttons and allow the user to invoke built-in Grid functionalities. You can also define custom commands or use templates to customize the Toolbar of the Telerik UI for ASP.NET MVC Grid.
Built-In Commands
You can configure the Toolbar and include any of the built-in commands:
.ToolBar(toolbar=> {
toolbar.Columns();
toolbar.Create();
toolbar.Save();
toolbar.Paste();
toolbar.Pdf();
toolbar.Excel();
toolbar.Search();
toolbar.Spacer();
toolbar.Separator();
})
| Command | Description | Resources |
|---|---|---|
| Columns | Displays a global column menu. | Column menu documentation |
| Create | Adds an empty data item to the grid. | Editing functionality documentation |
| Save | Persists any data changes done by the end user. | Editing functionality documentation |
| Paste | Enables the built-in paste operations. | Clipboard documentation |
| Exports the grid data in PDF format. | PDF Export documentation | |
| Excel | Exports the grid data in MS Excel format. | Excel Export documentation |
| Search | Adds the built-in search panel for the Grid. | Search Panel documentation |
| Spacer | Moves the tools that are declared after it to the right side of the ToolBar. | |
| Separator | Acts as a delimiter between the ToolBar commands. |
Custom Commands
The Telerik UI for ASP.NET MVC Grid supports adding custom commands to it's Toolbar.
The following example demonstrates how to add a custom command to the Toolbar:
.ToolBar(toolbar=> {
toolbar.Custom().Text("Click me").HtmlAttributes(new { id = "customCommand" });
})
<script>
$(document).ready(function(){
$("#customCommand").click(function (e) {
e.preventDefault();
alert('click')
//add custom command logic here
});
})
</script>
Toolbar Template
The Telerik UI for ASP.NET MVC Grid also supports using a template for the Toolbar. You can define a template by using the ClientTemplate() or the ClientTemplateid() configuration options.
.ToolBar(toolbar => {
toolbar.ClientTemplateId("GridToolbarTemplate");
})
When you use a Toolbar Template, and you also want to use a built-in command, then add the markup for the desired command. The following example demonstrates how to add the Pdf and Search commands to the Toolbar Template.
<script id="GridToolbarTemplate" type="text/x-kendo-template">
<div class="refreshBtnContainer">
<a href="\\#" class="k-pager-refresh k-link k-button k-button-solid-base k-button-solid k-button-md k-rounded-md k-button-icon" title="Refresh"><span class="k-icon k-i-reload"></span></a>
</div>
<a role="button" class="k-button k-button-solid-base k-button-solid k-button-md k-rounded-md k-button-icontext k-grid-pdf" href="\\#"><span class="k-icon k-i-file-pdf"></span>Export to PDF</a>
<div class="toolbar">
<label class="category-label" for="category">Show products by category:</label>
@(Html.Kendo().DropDownList()
.Name("categories")
.OptionLabel("All")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
.AutoBind(false)
.Events(e => e.Change("categoriesChange"))
.HtmlAttributes(new { style = "width: 150px;" })
.DataSource(ds =>
{
ds.Read("ToolbarTemplate_Categories", "Grid");
})
.ToClientTemplate()
)
</div>
<span class="k-textbox k-grid-search k-display-flex">
<input autocomplete="off" placeholder="Search..." title="Search..." class="k-input">
<span class="k-input-icon"><span class="k-icon k-i-search"></span></span>
</span>
</script>
As of Telerik UI for ASP.NET MVC R3 2023 SP1 release you can use the Template component to define custom ToolBar commands, alongside the default ToolBar commands.
The following example demonstrates how you can add a Button and DropDownList components to the Grid's Toolbar, along with a default Excel command demonstrated in the Telerik UI for ASP.NET MVC Grid Toolbar Template Demo.
@(Html.Kendo().Grid<Kendo.Mvc.Examples.Models.ProductViewModel>()
.Name("grid")
.ToolBar(toolbar=> {
toolbar.Custom().ClientTemplate(
Html.Kendo().Template().AddComponent(c=>c
.Button()
.Name("refresh")
.Icon("arrow-rotate-cw")
.HtmlAttributes(new {title="Refresh"})
.Events(ev=>ev.Click("refresh"))
));
toolbar.Spacer();
toolbar.Custom().ClientTemplate(
Html.Kendo().Template()
.AddHtml("<label class=\"category-label\" for=\"category\">Show products by category:</label>")
.AddComponent(c => c
.DropDownList()
.Name("categories")
.OptionLabel("All")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
.AutoBind(false)
.Events(e => e.Change("categoriesChange"))
.HtmlAttributes(new { style = "width: 150px;" })
.DataSource(ds =>
{
ds.Read("ToolbarTemplate_Categories", "Grid");
})
));
toolbar.Separator();
toolbar.Excel();
})
)
<script>
function refresh() {
var grid = $("#grid").data("kendoGrid");
grid.dataSource.read();
}
function categoriesChange() {
var value = this.value(),
grid = $("#grid").data("kendoGrid");
if (value) {
grid.dataSource.filter({ field: "CategoryID", operator: "eq", value: parseInt(value) });
} else {
grid.dataSource.filter({});
}
}
</script>
Server-side rendering of the ToolBar Template
Rendering of the Toolbar on the server is supported by using the .Template() configuration. The following example demonstrates how to define a server-side ToolBar Template.
@(Html.Kendo().Grid<Kendo.Mvc.Examples.Models.ProductViewModel>()
.Name("grid")
.ToolBar(toolbar =>
{
toolbar.Template(@<text>
<div class="refreshBtnContainer">
<a href="\\#" class="k-pager-refresh k-link k-button k-button-solid-base k-button-solid k-button-md k-rounded-md" title="Refresh"><span class="k-button-icon k-icon k-i-reload"></span></a>
</div>
<div class="toolbar">
<label class="category-label" for="category">Show products by category:</label>
@(Html.Kendo().DropDownList()
.Name("categories")
.OptionLabel("All")
.DataTextField("CategoryName")
.DataValueField("CategoryID")
.AutoBind(false)
.Events(e => e.Change("categoriesChange"))
.HtmlAttributes(new { style = "width: 150px;" })
.DataSource(ds =>
{
ds.Read("ToolbarTemplate_Categories", "Grid");
})
)
</div>
</text>);
})
<script>
$(document).ready( function () {
var grid = $("#grid");
grid.find(".k-grid-toolbar").on("click", ".k-pager-refresh", function (e) {
e.preventDefault();
grid.data("kendoGrid").dataSource.read();
});
});
function categoriesChange() {
var value = this.value(),
grid = $("#grid").data("kendoGrid");
if (value) {
grid.dataSource.filter({ field: "CategoryID", operator: "eq", value: parseInt(value) });
} else {
grid.dataSource.filter({});
}
}
</script>
<style>
#grid .k-grid-toolbar
{
padding: .6em 1.3em .6em .4em;
}
.category-label
{
vertical-align: middle;
padding-right: .5em;
}
#category
{
vertical-align: middle;
}
.refreshBtnContainer {
display: inline-block;
}
.k-grid .toolbar {
margin-left: auto;
margin-right: 0;
}
</style>