In this article I will explain with an example, how to export WebGrid to Excel file in ASP.Net Core Razor Pages.
The WebGrid will be populated from database using Entity Framework and then the WebGrid will be sent as HTML string to the PageModel which will be exported to Excel file in ASP.Net Core Razor Pages.
 
 
MVC6 Grid for ASP.Net Core
This article makes use of MVC6 Grid library for implementing WebGrid, as it is not available by default in .Net Core.
For more details on how to use MVC6 Grid, please refer the article Using MVC6 Grid in ASP.Net Core Razor Pages.
 
 
Database
Here I am making use of Microsoft’s Northwind Database. You can download it from here.
Download and install Northwind Database
 
 
Namespaces
You need to import the following namespace.
using System.Text;
 
 
Model
The Model class consists of the following four properties.
public class Customer
{
    public string CustomerID { get; set; }
    public string ContactName { get; set; }
    public string City { get; set; }
    public string Country { get; set; }
}
 
 
Database Context
Once the Entity Framework is configured and connected to the database table, the Database Context will look as shown below.
Note: For beginners in ASP.Net Core and Entity Framework, please refer my article ASP.Net Core Razor Pages: Simple Entity Framework Tutorial with example. It covers all the information needed for connecting and configuring Entity Framework with ASP.Net Core.
 
using Microsoft.EntityFrameworkCore;
 
namespace Export_WebGrid_Excel_Razor_Core
{
    public class DBCtx : DbContext
    {
        public DBCtx(DbContextOptions<DBCtx> options) : base(options)
        {
           
        }
       
        public DbSet<Customer> Customers { get; set; }
    }
}
 
 
Razor PageModel (Code-Behind)
The PageModel consists of following two Handler methods.
Handler method for handling GET operation
Inside this Handler method, the Top 10 records are fetched from the Customers table using Entity Framework and assigned to the public property Customers.
 
Handler method for handling the Excel file Export and Download operation
This Handler method is executed when the Export Button is clicked.
Note: The following Handler method performs File Download operation. Hence the return type is set to FileResult.
 
The HTML string sent from the Razor Page is extracted from the GridHtml parameter.
Then, the HTML string is read and converted to a Byte Array using the GetBytes method of Encoding class.
Finally, the Byte Array is exported and downloaded as Excel file using the File function.
public class IndexModel : PageModel
{
    private DBCtx Context { get; }
 
    public IndexModel(DBCtx _context)
    {
        this.Context = _context;
    }
 
    public List<Customer> Customers { get; set; }
 
    public void OnGet()
    {
        this.Customers = this.Context.Customers.Take(10).ToList();
    }
 
    public FileResult OnPostExport(string GridHtml)
    {
        return File(Encoding.ASCII.GetBytes(GridHtml), "application/vnd.ms-excel", "Grid.xls");
    }
}
 
 
Razor Page (HTML)
Inside the Razor Page, ASP.Net TagHelpers, NonFactors.Mvc.Grid namespace and mvc-grid.css file is inherited.
Displaying the Records
For displaying the records, MVC6 Grid is used.
The public property of Generic List object of the Customer Model class is accessed through PageModel inside the Razor Page and passed to the Grid function of the MVC6 Grid HTML Helper class.
 
Exporting WebGrid to Excel file
Below the MVC6 WebGrid, there is an HTML Form within which a Submit Button has been placed.
The Export Button has been set with the POST Handler method using the asp-page-handler attribute.
Note: In the Razor PageModel, the Handler method name is OnPostExport but here it will be specified as Export when calling from the Razor HTML Page.
 
Also, there is an HTML Hidden Field element which will be used to send the MVC6 WebGrid content to the PageModel.
When the Export Button is clicked, first the HTML of the MVC6 WebGrid is extracted and set into the Hidden Field element and finally, the Form is submitted.
@page
@model Export_WebGrid_Excel_Razor_Core.Pages.IndexModel
@addTagHelper*, Microsoft.AspNetCore.Mvc.TagHelpers
@using NonFactors.Mvc.Grid;
@{
    Layout = null;
}
 
<!DOCTYPE html>
 
<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>Index</title>
    <link href="~/css/mvc-grid/mvc-grid.css" rel="stylesheet" />
</head>
<body>
    <h4>Customers</h4>
    <hr />
    <div id="Grid">
        @(Html.Grid(Model.Customers).Build(columns =>
            {
                columns.Add(model => model.CustomerID).Titled("CustomerID");
                columns.Add(model => model.ContactName).Titled("ContactName");
                columns.Add(model => model.City).Titled("City");
                columns.Add(model => model.Country).Titled("Country");
            })
        )
    </div>
    <br /><br />
    <form method="post">
        <input type="hidden" name="GridHtml" />
        <input type="submit" id="btnSubmit" value="Export" asp-page-handler="Export" />
    </form>
    <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
ASP.Net Core Razor Pages: Export WebGrid to Excel file
 
Exported Excel file
ASP.Net Core Razor Pages: Export WebGrid to Excel file
 
 
Downloads
Download Code