Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / GridColumnBuilder<TColumn, TColumnBuilder>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

GridColumnBuilder<TColumn, TColumnBuilder>

Class

Defines the fluent interface for configuring columns.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TColumn

TColumnBuilder

The type of the column builder.

Syntax:
C#
public abstract class GridColumnBuilder<TColumn, TColumnBuilder> : GridColumnBuilderBase<TColumn, TColumnBuilder> where TColumn : IGridColumn where TColumnBuilder : GridColumnBuilder<TColumn, TColumnBuilder>

Inheritance: objectGridColumnBuilderBase<TColumn, TColumnBuilder>GridColumnBuilder<TColumn, TColumnBuilder>

Derived Classes: GridActionColumnBuilderGridBoundColumnBuilder<T>GridPinColumnBuilderGridSelectColumnBuilderGridTemplateColumnBuilder<T>

Inherited Members GridColumnBuilderBase<TColumn, TColumnBuilder>.Title(string)GridColumnBuilderBase<TColumn, TColumnBuilder>.HeaderHtmlAttributes(object, bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.HeaderHtmlAttributes(IDictionary<string, object>, bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.HtmlAttributes(object, bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.HtmlAttributes(IDictionary<string, object>, bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.HtmlAttributes(string)GridColumnBuilderBase<TColumn, TColumnBuilder>.Media(string)GridColumnBuilderBase<TColumn, TColumnBuilder>.MinScreenWidth(int)GridColumnBuilderBase<TColumn, TColumnBuilder>.MinResizableWidth(int)GridColumnBuilderBase<TColumn, TColumnBuilder>.Width(int)GridColumnBuilderBase<TColumn, TColumnBuilder>.Width(string)GridColumnBuilderBase<TColumn, TColumnBuilder>.Visible(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Draggable(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Locked()GridColumnBuilderBase<TColumn, TColumnBuilder>.Locked(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Lockable(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Sticky()GridColumnBuilderBase<TColumn, TColumnBuilder>.Sticky(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Stickable()GridColumnBuilderBase<TColumn, TColumnBuilder>.Stickable(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Hidden(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Hidden()GridColumnBuilderBase<TColumn, TColumnBuilder>.HeaderTemplate(Action)GridColumnBuilderBase<TColumn, TColumnBuilder>.HeaderTemplate(string)GridColumnBuilderBase<TColumn, TColumnBuilder>.HeaderTemplate(Func<object, object>)GridColumnBuilderBase<TColumn, TColumnBuilder>.Exportable(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Exportable(Action<GridColumnExportableBuilder>)GridColumnBuilderBase<TColumn, TColumnBuilder>.ColumnMenu(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Resizable(bool)GridColumnBuilderBase<TColumn, TColumnBuilder>.Columnobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

GridColumnBuilder(TColumn)

Initializes a new instance of the GridColumnBuilder<TColumn, TColumnBuilder> class.

C#
protected GridColumnBuilder(TColumn column)
Parameters:columnTColumn

The column.

Methods

ClientFooterTemplate(string)

Sets the client footer template for the column.

C#
public TColumnBuilder ClientFooterTemplate(string template)
Parameters:templatestring

The action defining the template.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.Name).ClientFooterTemplate("Template value")))

ClientFooterTemplate<TModel>(TemplateBuilder<TModel>)

C#
public TColumnBuilder ClientFooterTemplate<TModel>(TemplateBuilder<TModel> templateBuilder)
Parameters:templateBuilderTemplateBuilder<TModel>Returns:

TColumnBuilder

ClientFooterTemplateHandler(string)

C#
public TColumnBuilder ClientFooterTemplateHandler(string handler)
Parameters:handlerstringReturns:

TColumnBuilder

ClientGroupFooterTemplate(string)

Sets the client group footer template for the column.

C#
public TColumnBuilder ClientGroupFooterTemplate(string template)
Parameters:templatestring

The template

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.Name).ClientGroupFooterTemplate("Template value")))

ClientGroupFooterTemplate<TModel>(TemplateBuilder<TModel>)

C#
public TColumnBuilder ClientGroupFooterTemplate<TModel>(TemplateBuilder<TModel> templateBuilder)
Parameters:templateBuilderTemplateBuilder<TModel>Returns:

TColumnBuilder

ClientGroupFooterTemplateHandler(string)

C#
public TColumnBuilder ClientGroupFooterTemplateHandler(string handler)
Parameters:handlerstringReturns:

TColumnBuilder

ClientGroupFooterTemplateView(MvcHtmlString)

Sets the client group footer template for the column.

C#
public TColumnBuilder ClientGroupFooterTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The partial view that will be rendered within the template.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid&lt;User&gt;()
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).ClientGroupFooterTemplateView(Html.Partial("_NamePartial"));
}))

FooterHtmlAttributes(IDictionary<string, object>, bool)

Sets the HTML attributes applied to the footer cell of the column.

C#
public TColumnBuilder FooterHtmlAttributes(IDictionary<string, object> attributes, bool encodeAttributes = true)
Parameters:attributesIDictionary<string, object>

The attributes.

encodeAttributesbool

Indicates whether the attributes will be encoded. By default the HtmlAttibutes are encoded.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).FooterHtmlAttributes(new {@class="order-footer"})))

FooterHtmlAttributes(IDictionary<string, object>)

Sets the HTML attributes applied to the footer cell of the column.

C#
public TColumnBuilder FooterHtmlAttributes(IDictionary<string, object> attributes)
Parameters:attributesIDictionary<string, object>

The attributes.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).FooterHtmlAttributes(new {@class="order-footer"})))

FooterHtmlAttributes(object, bool)

Sets the HTML attributes applied to the footer cell of the column.

C#
public TColumnBuilder FooterHtmlAttributes(object attributes, bool encodeAttributes = true)
Parameters:attributesobject

The attributes.

encodeAttributesbool

Indicates whether the attributes will be encoded. By default the HtmlAttibutes are encoded.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).FooterHtmlAttributes(new {@class="order-footer"})))

FooterHtmlAttributes(object)

Sets the HTML attributes applied to the footer cell of the column.

C#
public TColumnBuilder FooterHtmlAttributes(object attributes)
Parameters:attributesobject

The attributes.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).FooterHtmlAttributes(new {@class="order-footer"})))

FooterTemplate(Action)

Sets the server-side footer template for the column.

C#
public TColumnBuilder FooterTemplate(Action template)
Parameters:templateAction

The action defining the template.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.Name).FooterTemplate(x=&gt;x.Average)))

FooterTemplate(Func<object, object>)

Sets the footer template for the column.

C#
public TColumnBuilder FooterTemplate(Func<object, object> template)
Parameters:templateFunc<object, object>

The action defining the template.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.Name).FooterTemplate(@&lt;text&gt; Template &lt;/text&gt;)))

FooterTemplate(string)

Sets the footer template for the column.

C#
public TColumnBuilder FooterTemplate(string template)
Parameters:templatestring

The string defining the template.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.Name).FooterTemplate("Template")))

IncludeInMenu(bool)

Specifys whether the columns should be included in column header menu. By default all columns are included. The column also need to have a Title set in order to be included in the menu.

C#
public TColumnBuilder IncludeInMenu(bool value)
Parameters:valuebool

The value used for the condition.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).IncludeInMenu((bool)ViewData["hidden"])))
In this article
DefinitionConstructorsGridColumnBuilder(TColumn)MethodsClientFooterTemplate(string)ClientFooterTemplate<TModel>(TemplateBuilder<TModel>)ClientFooterTemplateHandler(string)ClientGroupFooterTemplate(string)ClientGroupFooterTemplate<TModel>(TemplateBuilder<TModel>)ClientGroupFooterTemplateHandler(string)ClientGroupFooterTemplateView(MvcHtmlString)FooterHtmlAttributes(IDictionary<string, object>, bool)FooterHtmlAttributes(IDictionary<string, object>)FooterHtmlAttributes(object, bool)FooterHtmlAttributes(object)FooterTemplate(Action)FooterTemplate(Func<object, object>)FooterTemplate(string)IncludeInMenu(bool)
Not finding the help you need?
Contact Support