In this article I will explain with an example, how to export
WebGrid to
Excel file with formatting in ASP.Net MVC Razor.
First the
WebGrid will be populated from database using
Entity Framework and then the generated HTML Table of
WebGrid will be sent as HTML string to the Controller which ultimately will be exported to
Excel file in ASP.Net MVC Razor.
Database
Here I am making use of Microsoft’s Northwind Database. You can download it from here.
Entity Framework Model
Once the
Entity Framework is configured and connected to the database table, the Model will look as shown below.
Controller
The Controller consists of two Action methods.
Action method for handling GET operation
Inside this Action method, the Top 10 Customer records are fetched and returned to the View.
Action method for handling the Excel File Export and Download operation
This Action method is executed when the Export Submit button is clicked.
Note: The following Action method performs File Download and hence the return type is set to FileResult.
The HTML of the
WebGrid sent from the View is extracted from the
GridHtml parameter.
The HTML string is converted into Byte Array using the GetBytes functions of the ASCII class.
Finally it is exported and downloaded as
Excel file using the
File function.
public class HomeController : Controller
{
// GET: Home
public ActionResult Index()
{
NorthwindEntities entities = new NorthwindEntities();
return View(from customer in entities.Customers.Take(10)
select customer);
}
[HttpPost]
[ValidateInput(false)]
public FileResult Export(string GridHtml)
{
return File(Encoding.ASCII.GetBytes(GridHtml), "application/vnd.ms-excel", "Grid.xls");
}
}
View
Inside the View, in the very first line the Customer Entity is declared as IEnumerable which specifies that the Model will be available as a Collection.
For displaying the records, the
WebGrid is rendered using
GetHtml function which renders the
WebGrid using Model.
The
WebGrid will render as an HTML Grid (Table) consisting of the records from the Customers Table.
In order to export
WebGrid with formatting, in-line CSS styles are applied to the
WebGrid and its Header and Data rows using jQuery.
There is an HTML Hidden Field element which is used to send the HTML of the
WebGrid's HTML content to the Controller’s Action method.
Finally there’s an HTML Submit button enclosed inside a Form with the Action method specified as Export.
When this Button will be clicked, first the HTML of the
WebGrid's HTML is extracted and set into the Hidden Field element and finally the Form is submitted.
@model IEnumerable<Customer>
@{
Layout = null;
WebGrid webGrid = new WebGrid(source: Model, canSort: false, canPage: false);
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width"/>
<title>Index</title>
</head>
<body>
<h4>Customers</h4>
<hr/>
<div id="Grid">
@webGrid.GetHtml(
htmlAttributes: new { @id = "WebGrid" },
columns: webGrid.Columns(
webGrid.Column("CustomerID", "Customer Id"),
webGrid.Column("ContactName", "Customer Name"),
webGrid.Column("City", "City"),
webGrid.Column("Country", "Country")))
</div>
<br/>
<br/>
@using (Html.BeginForm("Export", "Home", FormMethod.Post))
{
<input type="hidden" name="GridHtml"/>
<input type="submit" id="btnSubmit" value="Export"/>
}
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
<script type="text/javascript">
$(function () {
//Add CSS to the Table for formatting.
$("#Grid table").attr("cellpadding", "5");
$("#Grid table").css({ "border-collapse": "collapse", "border": "1px solid #ccc" });
$("#Grid th").css({ "background-color": "#B8DBFD", "border": "1px solid #ccc" });
$("#Grid td").css({ "width": "150px", "border": "1px solid #ccc" });
//Assign Click event to Button.
$("#btnSubmit").click(function () {
$("input[name='GridHtml']").val($("#Grid").html());
});
});
</script>
</body>
</html>
Screenshots
WebGrid
Exported Excel File
Downloads
Download Code