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

GridColumnBuilderBase<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 GridColumnBuilderBase<TColumn, TColumnBuilder> where TColumn : IGridColumn where TColumnBuilder : GridColumnBuilderBase<TColumn, TColumnBuilder>

Inheritance: objectGridColumnBuilderBase<TColumn, TColumnBuilder>

Derived Classes: GridColumnBuilder<TColumn, TColumnBuilder>GridColumnGroupBuilder<T>

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

Constructors

GridColumnBuilderBase(TColumn)

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

C#
protected GridColumnBuilderBase(TColumn column)
Parameters:columnTColumn

The column.

Properties

Column

TColumn

Gets or sets the column.

C#
public TColumn Column { get; }
Property Value:

The column.

Methods

ColumnMenu(bool)

If set to false the column menu will not be rendered for the specific column.

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

If true the column menu will be rendered, otherwise not.

Returns:

TColumnBuilder

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

Draggable(bool)

Makes the column draggable or not. By default the columns are not draggable.

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

If true the column is draggable, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Draggable((bool)ViewData["draggable"])))

Exportable(Action<GridColumnExportableBuilder>)

The configurator is used to configure the exportable setting of the column.

C#
public TColumnBuilder Exportable(Action<GridColumnExportableBuilder> configurator)
Parameters:configuratorAction<GridColumnExportableBuilder>

The configurator.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Exportable(x=&gt;x.Excel(true).Pdf(false))))

Exportable(bool)

If set to false the column will be excluded from the exported Excel/PDF files.

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

If true the column is exportable, otherwise not.

Returns:

TColumnBuilder

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

HeaderHtmlAttributes(IDictionary<string, object>, bool)

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

C#
public TColumnBuilder HeaderHtmlAttributes(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).HeaderHtmlAttributes(new {@class="order-header"})))

HeaderHtmlAttributes(object, bool)

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

C#
public TColumnBuilder HeaderHtmlAttributes(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).HeaderHtmlAttributes(new {@class="order-header"})))

HeaderTemplate(Action)

Sets the server-side header template for the column. If sorting is enabled, the template content wrapper must have a k-link CSS class.

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

The action defining the template.

Returns:

TColumnBuilder

HeaderTemplate(Func<object, object>)

Sets the header template for the column. If sorting is enabled, the template content wrapper must have a k-link CSS class.

C#
public TColumnBuilder HeaderTemplate(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(c =&gt; c.Name).HeaderTemplate(@&lt;text&gt;Template&lt;/text&gt;);
}))

HeaderTemplate(string)

Sets the header template for the column. If sorting is enabled, the template content wrapper must have a k-link CSS class.

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

The string defining the template.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).HeaderTemplate("Template value");
}))

Hidden()

Hides a column. By default all columns are not hidden. Hidden columns are rendered in the output HTML but are hidden.

C#
public TColumnBuilder Hidden()
Returns:

TColumnBuilder

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

Hidden(bool)

Makes the column hidden or not. By default all columns are not hidden. Hidden columns are rendered in the output HTML but are hidden.

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

If true the column is hidden, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Hidden((bool)ViewData["hidden"])))

HtmlAttributes(IDictionary<string, object>, bool)

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

C#
public TColumnBuilder HtmlAttributes(IDictionary<string, object> attributes, bool encodeAttributes)
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).HtmlAttributes(new {@class="order-cell"})))

HtmlAttributes(object, bool)

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

C#
public TColumnBuilder HtmlAttributes(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).HtmlAttributes(new {@class="order-cell"})))

HtmlAttributes(string)

Sets name of the handler that sets the html attributes

C#
public TColumnBuilder HtmlAttributes(string attributesHandler)
Parameters:attributesHandlerstring

The attributes handler name.

Returns:

TColumnBuilder

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

Lockable(bool)

If set to false the column will remain in the side of the grid into which its own locked configuration placed it.

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

If true the column is lockable, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Lockable((bool)ViewData["lockable"])))

Locked()

Makes the column static. By default all columns are not locked.

C#
public TColumnBuilder Locked()
Returns:

TColumnBuilder

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

Locked(bool)

Makes the column static or not. By default all columns are not locked.

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

If true the column is locked, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Locked((bool)ViewData["locked"])))

Media(string)

Sets the media query condition that needs to be satisfied for a column to remain visible.

C#
public TColumnBuilder Media(string value)
Parameters:valuestring

The text.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Media("(min-width: 600px)")))

MinResizableWidth(int)

The pixel screen width below which the user will not be able to resize the column via the UI.

C#
public TColumnBuilder MinResizableWidth(int value)
Parameters:valueintReturns:

TColumnBuilder

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

MinScreenWidth(int)

Sets the minimum screen width in pixels at which the column will become hidden.

C#
public TColumnBuilder MinScreenWidth(int value)
Parameters:valueintReturns:

TColumnBuilder

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

Resizable(bool)

If set to false the column will become non-resizable, while all the other columns remaining resizable in the grid component. In order for this property to work, grid's resizable functionality must be be enabled.

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

If false the column is not resizable.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Resizable(resizing =&gt; resizing.Columns(true))
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Resizable(false)))

Stickable()

Makes the column stickable. By default all columns are not stickable.

C#
public TColumnBuilder Stickable()
Returns:

TColumnBuilder

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

Stickable(bool)

Makes the column stickable or not. By default all columns are not stickable.

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

If true the column is stickable, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Stickable((bool)ViewData["stickable"])))

Sticky()

Makes the column sticky. By default all columns are not sticky.

C#
public TColumnBuilder Sticky()
Returns:

TColumnBuilder

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

Sticky(bool)

Makes the column sticky or not. By default all columns are not sticky.

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

If true the column is sticky, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Sticky((bool)ViewData["sticky"])))

Title(string)

Sets the title displayed in the header of the column. Any HTML entities or tags should be encoded, or use a HeaderTemplate instead.

C#
public TColumnBuilder Title(string text)
Parameters:textstring

The text.

Returns:

TColumnBuilder

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

Visible(bool)

Makes the column visible or not. By default all columns are visible. Invisible columns are not rendered in the output HTML.

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

If true the column is visible, otherwise not.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("Grid")
.Columns(columns =&gt; columns.Bound(o =&gt; o.OrderID).Visible((bool)ViewData["visible"])))

Width(int)

Sets the width of the column in pixels.

C#
public TColumnBuilder Width(int pixelWidth)
Parameters:pixelWidthint

The width in pixels.

Returns:

TColumnBuilder

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

Width(string)

Sets the width of the column using CSS syntax.

C#
public TColumnBuilder Width(string value)
Parameters:valuestring

The width to set.

Returns:

TColumnBuilder

Example:
C#
@(Html.Kendo().Grid(Model)
.Name("grid")
.Columns(columns =&gt;
{
columns.Bound(c =&gt; c.Name).Width("200px");
}))
In this article
DefinitionConstructorsGridColumnBuilderBase(TColumn)PropertiesColumnMethodsColumnMenu(bool)Draggable(bool)Exportable(Action<GridColumnExportableBuilder>)Exportable(bool)HeaderHtmlAttributes(IDictionary<string, object>, bool)HeaderHtmlAttributes(object, bool)HeaderTemplate(Action)HeaderTemplate(Func<object, object>)HeaderTemplate(string)Hidden()Hidden(bool)HtmlAttributes(IDictionary<string, object>, bool)HtmlAttributes(object, bool)HtmlAttributes(string)Lockable(bool)Locked()Locked(bool)Media(string)MinResizableWidth(int)MinScreenWidth(int)Resizable(bool)Stickable()Stickable(bool)Sticky()Sticky(bool)Title(string)Visible(bool)Width(int)Width(string)
Not finding the help you need?
Contact Support