If set to true the grid will perform custom binding.
Parameters value -System.Boolean
If true enables custom binding.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.EnableCustomBinding(true)
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
BindTo(System.Collections.Generic.IEnumerable)
Binds the grid to a list of objects
Parameters dataSource -System.Collections.Generic.IEnumerable<T>
The data source.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@model IEnumerable<Product>
@(Html.Kendo().Grid<Product>()
.Name("grid")
.BindTo(Model)
)
BindTo(System.Collections.IEnumerable)
Binds the grid to a list of objects
Parameters dataSource -System.Collections.IEnumerable
The data source.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@model IEnumerable;
@(Html.Kendo().Grid<Product>()
.Name("grid")
.BindTo(Model)
)
Editable(System.Action)
Sets the editing configuration of the grid.
Parameters configurator - System.Action<GridEditingSettingsBuilder>The lambda which configures the editing
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.Editable(editing => editing.Mode(GridEditMode.PopUp))
)
Editable(Kendo.Mvc.UI.GridEditMode)
Sets the edit mode of the grid.
Parameters editMode - GridEditModeThe lambda which configures the editing
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.Editable(editing => editing.Mode(GridEditMode.PopUp))
)
Editable()
Sets the editing configuration of the grid.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.Editable(editing => editing.Mode(GridEditMode.PopUp))
)
DataSource(System.Action)
Sets the data source configuration of the grid.
Parameters configurator - System.Action<DataSourceBuilder>The lambda which configures the data source
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
DataSource(System.String)
Sets the ID of the DataSource widget used by the Grid.
Parameters dataSourceId -System.String
The name of the DataSource
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.DataSource("dataSource1")
)
@(Html.Kendo().DataSource<Product>()
.Name("dataSource1")
.Ajax(ds=>ds
.Read(read => read.Action("Products_Read", "Home"))
.PageSize(20)
)
)
Pageable()
Enables grid paging.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Pageable()
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Pageable(System.Action)
Sets the paging configuration of the grid.
Parameters configurator - System.Action<GridPageableSettingsBuilder>The lambda which configures the paging
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Pageable(paging =>
paging.Refresh(true)
)
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Filterable()
Enables grid filtering.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Filterable()
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Filterable(System.Action)
Sets the filtering configuration of the grid.
Parameters configurator - System.Action<GridFilterableSettingsBuilder>The lambda which configures the filtering
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Filterable(filtering => filtering.Enabled(true))
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Resizable(System.Action)
Sets the resizing configuration of the grid.
Parameters configurator - System.Action<GridResizingSettingsBuilder>The lambda which configures the resizing
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.Resizable(resizing => resizing.Columns(true))
)
Reorderable(System.Action)
Sets the reordering configuration of the grid.
Parameters configurator - System.Action<GridReorderingSettingsBuilder>The lambda which configures the reordering
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.Reorderable(reordering => reordering.Columns(true))
)
Selectable()
Enables grid row selection.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Selectable()
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Selectable(System.Action)
Sets the selection configuration of the grid.
Parameters configurator - System.Action<GridSelectionSettingsBuilder>The lambda which configures the selection
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Selectable(selection => selection.Enabled(true))
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Scrollable()
Enables grid scrolling.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Scrollable()
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Scrollable(System.Action)
Sets the scrolling configuration of the grid.
Parameters configurator - System.Action<GridScrollSettingsBuilder>The lambda which configures the scrolling
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Scrollable(scrolling => scrolling.Enabled(true))
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Columns(System.Action)
Sets the column configuration of the grid.
Parameters configurator - System.Action<GridColumnFactory>The lambda which configures columns
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(product => product.ProductName).Title("Product Name");
columns.Command(command => command.Destroy());
})
.DataSource(dataSource =>
dataSource
.Ajax()
.Destroy(destroy => destroy.Action("Products_Destroy", "Home"))
.Read(read => read.Action("Products_Read", "Home"))
)
)
Mobile()
Enables the adaptive rendering when viewed on mobile browser
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Mobile()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(20)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Mobile(Kendo.Mvc.UI.MobileMode)
Used to determine if adaptive rendering should be used when viewed on mobile browser
Parameters type - MobileModeDefines the type of the Mobile Mode
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Mobile(MobileMode.Phone)
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(20)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
ToolBar(System.Action)
Sets the toolbar configuration of the grid. Set the list of commands displayed in the Grid's Toolbar. Supports adding custom or built-in commands.
Parameters configurator - System.Action<GridToolBarCommandFactory>The lambda which configures the toolbar
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ToolBar(commands => commands.Create())
)
ToolBar(System.Action)
Sets the toolbar configuration of the grid. Set the list of commands displayed in the Grid's Toolbar. Supports adding custom or built-in commands.
Parameters configurator - System.Action<GridToolBarSettingsBuilder>The lambda which configures the toolbar
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ToolBar(commands => commands.Create())
)
ToolBar(System.String)
Sets toolbar template. When a String value is assigned to the toolbar configuration option, it will be treated as a single string template for the whole Grid toolbar and the string value will be passed as an argument to a kendo.template() function.
Parameters template -System.String
The action defining the template.
RETURNSReturns the current GridBuilder instance for method chaining.
Example ToolBar(Kendo.Mvc.UI.Fluent.TemplateBuilder)Sets the toolbar template. Use the Template Component to configure the Toolbar.
Parameters template - TemplateBuilder<TModel>The template component which contains the template.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ToolBar(Html.Kendo().Template().AddComponent(c => c
.Button()
.Name("refresh")
.Icon("arrow-rotate-cw")
))
)
ToolBar(Microsoft.AspNetCore.Html.IHtmlContent)
Sets toolbar template.
Parameters templateView -Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template.
RETURNSReturns the current GridBuilder instance for method chaining.
ToolBarClientTemplateId(System.String)Sets the id of the script element which contains the client-side toolbar template of the grid.
Parameters template -System.String
RETURNS
Returns the current GridBuilder instance for method chaining.
Example
<script id="toolbarTemplate" type="text/x-kendo-template">
<span>Toolbar content</span>
</script>
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ToolBar("toolbarTemplate")
)
ToolBarClientTemplateHandler(System.String)
Sets the toolbar template. When a Function value is assigned (it may be a kendo.template() function call or a generic function reference), then the return value of the function will be used to render the Grid Toolbar contents.
Parameters handler -System.String
The function handler which contains the template.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ToolBar("toolbarTemplateHandler")
)
Enables the Grid's Context Menu.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.ContextMenu()
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
)
Sets the ContextMenu configuration of the grid.
ParametersThe lambda which configures the Context Menu
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("Grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ContextMenu(menu => menu.Body(body => body.ExportPDF()))
)
ClientRowTemplate(System.String)
Sets the client-side row template of the grid. The client-side row template must contain a table row element (tr).
Parameters template -System.String
The template
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ClientRowTemplate(
"<tr>" +
"<td>#: ProductName #</td>" +
"<td>#: UnitsInStock #</td>" +
"</tr>"
)
)
ClientRowTemplateHandler(System.String)
The JavaScript function that returns the client-side row template of the grid. The client-side row template must contain a table row element (tr).
Parameters value -System.String
The name of the JavaScript function.
RETURNSReturns the current GridBuilder instance for method chaining.
ClientRowTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)Sets the client-side row template of the grid. The client-side row template must contain a table row element (tr).
Parameters template - TemplateBuilder<TModel>The template TemplateBuilder
RETURNSReturns the current GridBuilder instance for method chaining.
ClientAltRowTemplate(System.String)Sets the client-side alt row template of the grid. The client-side alt row template must contain a table row element (tr).
Parameters template -System.String
The template
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ClientAltRowTemplate(
"<tr class='k-alt'>" +
"<td>#: ProductName #</td>" +
"<td>#: UnitsInStock #</td>" +
"</tr>"
)
)
ClientAltRowTemplateHandler(System.String)
The JavaScript function that returns the client-side alt row template of the grid. The client-side alt row template must contain a table row element (tr).
Parameters template -System.String
RETURNS
Returns the current GridBuilder instance for method chaining.
ClientRowTemplate(System.Func) Parameters template - System.Func<Grid,String> ClientAltRowTemplate(System.Func) Parameters template - System.Func<Grid,String> ClientAltRowTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)Sets the client-side alt row template of the grid. The client-side row template must contain a table row element (tr).
Parameters template - TemplateBuilder<TModel>The template TemplateBuilder
RETURNSReturns the current GridBuilder instance for method chaining.
ClientDetailTemplateId(System.String)Sets the id of the script element which contains the client-side detail template of the grid.
Parameters id -System.String
The id
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ClientDetailTemplateId("detail-template")
)
<script id="detail-template" type="text/x-kendo-template">
Product Details:
<div>Product Name: #: ProductName # </div>
<div>Units In Stock: #: UnitsInStock #</div>
</script>
ClientDetailTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)
Sets the client-side detail template of the grid.
Parameters templateView -Microsoft.AspNetCore.Html.IHtmlContent
The template view
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<Product>()
.Name("grid")
.DataSource(dataSource =>
dataSource
.Ajax()
.Read(read => read.Action("Products_Read", "Home"))
)
.ClientDetailTemplateView(Html.Partial("detail-template"))
)
<script id="detail-template" type="text/x-kendo-template">
Product Details:
<div>Product Name: #: ProductName # </div>
<div>Units In Stock: #: UnitsInStock #</div>
</script>
ClientDetailTemplateHandler(System.String)
The JavaScript function that returns the client-side detail template of the grid.
Parameters handler -System.String
RETURNS
Returns the current GridBuilder instance for method chaining.
ClientDetailTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)Sets the client-side detail template of the grid.
Parameters template - TemplateBuilder<TModel>The template TemplateBuilder
RETURNSReturns the current GridBuilder instance for method chaining.
Width(System.Int32)Sets the width of the grid.
Parameters pixelWidth -System.Int32
The width of the Grid
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Width(300px)
.Scrollable()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(20)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Width(System.String)
Sets the width of the grid.
Parameters value -System.String
The width of the Grid
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Width("300px")
.Scrollable()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(20)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Height(System.Int32)
Sets the height of the grid.
Parameters pixelHeight -System.Int32
The height of the grid. Numeric values are treated as pixels.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Height(400)
.Pageable()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(10)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Height(System.String)
Sets the height of the grid.
Parameters value -System.String
The height of the grid.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Height("400px")
.Pageable()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(10)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Messages(System.Action)
Configures the grid messages.
Parameters configurator - System.Action<GridMessagesBuilder>Defines the text of the messages used by the Grid
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Messages(m => m.ExpandCollapseColumnHeader("E/C"))
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(20)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
Size(Kendo.Mvc.UI.ComponentSize)
Sets the size of the grid.
Parameters value - ComponentSizeThe size of the grid.
RETURNSReturns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Size(ComponentSize.Small)
.Pageable()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(10)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
If set to true the grid will prefix the query string parameters with its name. The default value is false.
Parameters prefix -System.Boolean
RETURNS
Returns the current GridBuilder instance for method chaining.
Example
@(Html.Kendo().Grid<OrderViewModel>()
.Name("grid")
.PrefixUrlParameters(true)
.Columns(columns =>
{
columns.Bound(p => p.OrderID).Filterable(false);
columns.Bound(p => p.Freight);
})
.Size(ComponentSize.Small)
.Pageable()
.DataSource(dataSource => dataSource
.Ajax()
.PageSize(10)
.Read(read => read.Action("Orders_Read", "Grid"))
)
)
AllowCopy(System.Action)
If set to true and selection of the Grid is enabled, the user could copy the selection into the clipboard and paste it into Excel or other similar programs that understand TSV/CSV formats. By default allowCopy is disabled and the default format is TSV. Can be set to a JavaScript object which represents the allowCopy configuration.
Parameters configurator - System.Action<GridAllowCopySettingsBuilder>The configurator for the allowcopy setting.
RETURNSReturns the current instance of GridBuilder .
AllowCopy()If set to true and selection of the Grid is enabled, the user could copy the selection into the clipboard and paste it into Excel or other similar programs that understand TSV/CSV formats. By default allowCopy is disabled and the default format is TSV. Can be set to a JavaScript object which represents the allowCopy configuration.
RETURNSReturns the current instance of GridBuilder .
AllowCopy(System.Boolean)If set to true and selection of the Grid is enabled, the user could copy the selection into the clipboard and paste it into Excel or other similar programs that understand TSV/CSV formats. By default allowCopy is disabled and the default format is TSV. Can be set to a JavaScript object which represents the allowCopy configuration.
Parameters enabled -System.Boolean
Enables or disables the allowcopy option.
RETURNSReturns the current instance of GridAllowCopySettingsBuilder .
AllowPaste(System.Boolean)If set to true and the selection functionality of the Grid is enabled, the user can paste the current textual content of the clipboard into the Grid.
Parameters value -System.Boolean
The value for AllowPaste
RETURNSReturns the current GridBuilder instance.
AllowPaste()If set to true and the selection functionality of the Grid is enabled, the user can paste the current textual content of the clipboard into the Grid.
RETURNSReturns the current GridBuilder instance.
AutoBind(System.Boolean)If set to false, the Grid will not bind to the data source during initialization, i.e. it will not call the fetch method of the dataSource instance. In such scenarios data binding will occur when the change event of the dataSource instance is fired. By default, autoBind is set to true and the widget will bind to the data source specified in the configuration.
Parameters value -System.Boolean
The value for AutoBind
RETURNSReturns the current GridBuilder instance.
ColumnResizeHandleWidth(System.Double)Defines the width of the column resize handle in pixels. Apply a larger value for easier grasping.
Parameters value -System.Double
The value for ColumnResizeHandleWidth
RETURNSReturns the current GridBuilder instance.
ColumnMenu(System.Action)If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled). By default the column menu is not enabled.Can be set to a JavaScript object which represents the column menu configuration.
Parameters configurator - System.Action<GridColumnMenuSettingsBuilder>The configurator for the columnmenu setting.
RETURNSReturns the current instance of GridBuilder .
ColumnMenu()If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled). By default the column menu is not enabled.Can be set to a JavaScript object which represents the column menu configuration.
RETURNSReturns the current instance of GridBuilder .
ColumnMenu(System.Boolean)If set to true the grid will display the column menu when the user clicks the chevron icon in the column headers. The column menu allows the user to show and hide columns, filter and sort (if filtering and sorting are enabled). By default the column menu is not enabled.Can be set to a JavaScript object which represents the column menu configuration.
Parameters enabled -System.Boolean
Enables or disables the columnmenu option.
RETURNSReturns the current instance of GridColumnMenuSettingsBuilder .
EncodeTitles(System.Boolean)If set to true the column title will be HTML-encoded before it is displayed. If set to false the column title will be displayed as is.
Parameters value -System.Boolean
The value for EncodeTitles
RETURNSReturns the current GridBuilder instance.
EncodeTitles()If set to true the column title will be HTML-encoded before it is displayed. If set to false the column title will be displayed as is.
RETURNSReturns the current GridBuilder instance.
Excel(System.Action)Configures the Kendo UI Grid Excel export settings.
Parameters configurator - System.Action<GridExcelSettingsBuilder>The configurator for the excel setting.
RETURNSReturns the current instance of GridBuilder .
Groupable(System.Action)If set to true the user could group the grid by dragging the column header cells. By default grouping is disabled.Can be set to a JavaScript object which represents the grouping configuration.
Parameters configurator - System.Action<GridGroupableSettingsBuilder>The configurator for the groupable setting.
RETURNSReturns the current instance of GridBuilder .
Groupable()If set to true the user could group the grid by dragging the column header cells. By default grouping is disabled.Can be set to a JavaScript object which represents the grouping configuration.
RETURNSReturns the current instance of GridBuilder .
Groupable(System.Boolean)If set to true the user could group the grid by dragging the column header cells. By default grouping is disabled.Can be set to a JavaScript object which represents the grouping configuration.
Parameters enabled -System.Boolean
Enables or disables the groupable option.
RETURNSReturns the current instance of GridGroupableSettingsBuilder .
Navigatable(System.Boolean)If set to true the user could navigate the component using the keyboard navigation. By default keyboard navigation is disabled.
Parameters value -System.Boolean
The value for Navigatable
RETURNSReturns the current GridBuilder instance.
Navigatable()If set to true the user could navigate the component using the keyboard navigation. By default keyboard navigation is disabled.
RETURNSReturns the current GridBuilder instance.
NoRecords(System.Action)If set to true and current view contains no records, message similar to "No records available" will be displayed. By default this option is disabled.
Parameters configurator - System.Action<GridNoRecordsSettingsBuilder>The configurator for the norecords setting.
RETURNSReturns the current instance of GridBuilder .
NoRecords()If set to true and current view contains no records, message similar to "No records available" will be displayed. By default this option is disabled.
RETURNSReturns the current instance of GridBuilder .
NoRecords(System.Boolean)If set to true and current view contains no records, message similar to "No records available" will be displayed. By default this option is disabled.
Parameters enabled -System.Boolean
Enables or disables the norecords option.
RETURNSReturns the current instance of GridNoRecordsSettingsBuilder .
Pdf(System.Action)Configures the Kendo UI Grid PDF export settings.
Parameters configurator - System.Action<GridPdfSettingsBuilder>The configurator for the pdf setting.
RETURNSReturns the current instance of GridBuilder .
PersistSelection(System.Boolean)Sets a value indicating whether the selection will be persisted when sorting, paging, filtering and etc are performed.
Parameters value -System.Boolean
The value for PersistSelection
RETURNSReturns the current GridBuilder instance.
PersistSelection()Sets a value indicating whether the selection will be persisted when sorting, paging, filtering and etc are performed.
RETURNSReturns the current GridBuilder instance.
Search(System.Action)Configures the Kendo UI Grid search bar settings.
Parameters configurator - System.Action<GridSearchSettingsBuilder>The configurator for the search setting.
RETURNSReturns the current instance of GridBuilder .
Sortable(System.Action)If set to true the user could sort the grid by clicking the column header cells. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.
Parameters configurator - System.Action<GridSortableSettingsBuilder>The configurator for the sortable setting.
RETURNSReturns the current instance of GridBuilder .
Sortable()If set to true the user could sort the grid by clicking the column header cells. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.
RETURNSReturns the current instance of GridBuilder .
Sortable(System.Boolean)If set to true the user could sort the grid by clicking the column header cells. By default sorting is disabled.Can be set to a JavaScript object which represents the sorting configuration.
Parameters enabled -System.Boolean
Enables or disables the sortable option.
RETURNSReturns the current instance of GridSortableSettingsBuilder .
DataLayoutMode(Kendo.Mvc.UI.DataLayoutMode)Defines the data layout mode of the grid.
Parameters value - DataLayoutModeThe value for DataLayoutMode
RETURNSReturns the current GridBuilder instance.
StackedLayoutSettings(System.Action)The stacked layout settings of the Grid.
Parameters configurator - System.Action<GridStackedLayoutSettingsSettingsBuilder>The configurator for the stackedlayoutsettings setting.
RETURNSReturns the current instance of GridBuilder .
StatusBarTemplate(System.String)The template which renders the Status Bar/Aggregates Bar.
Parameters value -System.String
The value for StatusBarTemplate
RETURNSReturns the current GridBuilder instance.
StatusBarTemplateId(System.String)The template which renders the Status Bar/Aggregates Bar.
Parameters templateId -System.String
The ID of the template element for StatusBarTemplate
RETURNSReturns the current GridBuilder instance.
StatusBarTemplateView(Microsoft.AspNetCore.Html.IHtmlContent)The template which renders the Status Bar/Aggregates Bar.
Parameters templateView -Microsoft.AspNetCore.Html.IHtmlContent
The view that contains the template for StatusBarTemplate
RETURNSReturns the current GridBuilder instance.
StatusBarTemplateHandler(System.String)The template which renders the Status Bar/Aggregates Bar.
Parameters templateHandler -System.String
The handler that returs the template for StatusBarTemplate
RETURNSReturns the current GridBuilder instance.
StatusBarTemplate(Kendo.Mvc.UI.Fluent.TemplateBuilder)The template which renders the Status Bar/Aggregates Bar.
Parameters template - TemplateBuilder<TModel>A Template component that configures the statusbartemplate.
RETURNSReturns the current GridBuilder instance.
LoaderType(Kendo.Mvc.UI.GridLoaderType)Defines the type of the loader that will be displayed while loading the data
Parameters value - GridLoaderTypeThe value for LoaderType
RETURNSReturns the current GridBuilder instance.
AdaptiveMode(Kendo.Mvc.UI.AdaptiveMode)Specifies the adaptive rendering of the component.
Parameters value - AdaptiveModeThe value for AdaptiveMode
RETURNSReturns the current GridBuilder instance.
Events(System.Action)Configures the client-side events.
Parameters configurator - System.Action<GridEventBuilder>The client events action.
RETURNSReturns the current GridBuilder instance.
Example
@(Html.Kendo().Grid()
.Name("Grid")
.Events(events => events
.BeforeEdit("onBeforeEdit")
)
)
ToComponent()
Returns the internal view component.
RETURNSThe instance that represents the component.
Expression(System.String)Sets the name of the component.
Parameters modelExpression -System.String
RETURNS
Returns the current instance.
Explorer(Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer)Sets the name of the component.
Parameters modelExplorer -Microsoft.AspNetCore.Mvc.ViewFeatures.ModelExplorer
RETURNS
Returns the current instance.
Name(System.String)Sets the name of the component.
Parameters componentName -System.String
The name.
RETURNSReturns the current instance.
Deferred(System.Boolean)Suppress initialization script rendering. Note that this options should be used in conjunction with
Parameters deferred -System.Boolean
RETURNS
Returns a DeferredWidgetBuilder instance.
HtmlAttributes(System.Object)Sets the HTML attributes.
Parameters attributes -System.Object
The HTML attributes.
RETURNSReturns the current instance.
HtmlAttributes(System.Collections.Generic.IDictionary)Sets the HTML attributes.
Parameters attributes -System.Collections.Generic.IDictionary<String,Object>
The HTML attributes.
RETURNSReturns the current instance.
ScriptAttributes(System.Object,System.Boolean)Sets the JavaScript attributes to the initialization script.
Parameters attributes -System.Object
The JavaScript attributes.
overrideAttributes -System.Boolean
Argument which determines whether attributes should be overriden.
RETURNSReturns the current instance.
ScriptAttributes(System.Collections.Generic.IDictionary,System.Boolean)Sets the JavaScript attributes to the initialization script.
Parameters attributes -System.Collections.Generic.IDictionary<String,Object>
The JavaScript attributes.
overrideAttributes -System.Boolean
Argument which determines whether attributes should be overriden.
RETURNSReturns the current instance.
Render()Renders the component in place.
ToHtmlString()Returns the HTML representation of the component.
WriteTo(System.IO.TextWriter,System.Text.Encodings.Web.HtmlEncoder) Parameters writer -System.IO.TextWriter
encoder - System.Text.Encodings.Web.HtmlEncoder
ToClientTemplate()
Returns the client template for the component.
AsModule(System.Boolean)Specifies whether the initialization script of the component will be rendered as a JavaScript module.
Parameters value -System.Boolean
RETURNS
Returns the current instance.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4