New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

GridExcelBuilder

Class

The fluent API for configuring the grid Excel export.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class GridExcelBuilder

Inheritance: objectGridExcelBuilder

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

Constructors

GridExcelBuilder(GridExcelSettings)

public GridExcelBuilder(GridExcelSettings excel)

Parameters:excelGridExcelSettings

Methods

AllPages(bool)

Specifies whether all pages should be exported

public GridExcelBuilder AllPages(bool allPages)

Parameters:allPagesbool

If the parameter is set to true all pages will be exported

Returns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.AllPages(true))
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Collapsible()

Enables or disables collapsible (grouped) rows, for grids with aggregates.

public GridExcelBuilder Collapsible()

Returns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.Collapsible())
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Collapsible(bool)

Enables or disables collapsible (grouped) rows, for grids with aggregates.

public GridExcelBuilder Collapsible(bool value)

Parameters:valuebool

The value for Collapsible

Returns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.Collapsible(true))
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

FileName(string)

Sets the file name of the excel file.

public GridExcelBuilder FileName(string fileName)

Parameters:fileNamestring

If the parameter is set to true all pages will be exported

Returns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.FileName("fileName"))
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

Filterable(bool)

Enables or disables filtering in the output Excel file.

public GridExcelBuilder Filterable(bool filterable)

Parameters:filterablebool

The value for Filterable

Returns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.Filterable(true))
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

ForceProxy(bool)

Forces the use of server-side proxy even if the browser supports local saving.

public GridExcelBuilder ForceProxy(bool forceProxy)

Parameters:forceProxybool

true if the server proxy should be used always; false for automatic detection

Returns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.ForceProxy(true))
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)

ProxyURL(string)

Set the url of the server side proxy. The proxy is responsible for returning the excel file to the end user. Used in browsers that don't support saving files from JavaScript.

public GridExcelBuilder ProxyURL(string url)

Parameters:urlstringReturns:

GridExcelBuilder

Example:

@(Html.Kendo().Grid&lt;OrderViewModel&gt;()
.Name("grid")
.ToolBar(t =&gt; t.Excel())
.Excel(e =&gt; e.ProxyURL("url"))
.Columns(columns =&gt;
{
columns.Bound(p =&gt; p.OrderID).Filterable(false);
columns.Bound(p =&gt; p.Freight);
})
.DataSource(dataSource =&gt; dataSource
.Ajax()
.PageSize(20)
.Read(read =&gt; read.Action("Orders_Read", "Grid"))
)
)