In this article I will explain with an example, how to export data from database to PDF file in ASP.Net Core Razor Pages.
The data from the database is fetched using Entity Framework and dynamic HTML string is generated using StringBuilder class.
Finally, the generated HTML string will be exported to PDF file using itext7.pdfhtml library in ASP.Net Core Razor Pages.
Installing itext7.pdfhtml Library
In order to install itext7.pdfhtml library, use the following command in Nuget Package Manager Console window.
Install-Package itext7.pdfhtml -Version 4.0.4
Database
Here I am making use of Microsoft’s Northwind Database. You can download it from here.
Namespaces
You need to import the following namespaces.
using System.IO;
using System.Text;
using iText.Html2pdf;
using iText.IO.Source;
using iText.Kernel.Geom;
using iText.Kernel.Pdf;
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.
using Microsoft.EntityFrameworkCore;
namespace Export_Data_Database_PDF_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 and returned to the Razor Page.
Handler method for handling the PDF File Export and Download operation
This Handler method is executed when the Export button is clicked.
Inside this Handler Method, the Top 10 Customer records are fetched from the Customers Table using Entity Framework and then using the StringBuilder class, a string consisting of an HTML Table is generated.
Then, the HTML string is read and saved to the MemoryStream class object.
Next, the ByteArrayOutputStream class object is created and passed to the PdfWriter class object and the PdfDocument is initialized using the PdfWriter class object.
Then, the ConvertToPdf method of HtmlConverter class is used to convert it to PDF document by passing the MemoryStream and PdfDocument object.
Finally, the ByteArrayOutputStream class object is converted to Byte Array and exported and downloaded as PDF 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()
{
List<object> customers = (from customer in this.Context.Customers.Take(10)
select new[] {
customer.CustomerID,
customer.ContactName,
customer.City,
customer.Country
}).ToList<object>();
//Building an HTML string.
StringBuilder sb = new StringBuilder();
//Table start.
sb.Append("<table border='1' cellpadding='5' cellspacing='0' style='border: 1px solid #ccc;font-family: Arial;'>");
//Building the Header row.
sb.Append("<tr>");
sb.Append("<th style='background-color: #B8DBFD;border: 1px solid #ccc'>CustomerID</th>");
sb.Append("<th style='background-color: #B8DBFD;border: 1px solid #ccc'>ContactName</th>");
sb.Append("<th style='background-color: #B8DBFD;border: 1px solid #ccc'>City</th>");
sb.Append("<th style='background-color: #B8DBFD;border: 1px solid #ccc'>Country</th>");
sb.Append("</tr>");
//Building the Data rows.
for (int i = 0; i < customers.Count; i++)
{
string[] customer = (string[])customers[i];
sb.Append("<tr>");
for (int j = 0; j < customer.Length; j++)
{
//Append data.
sb.Append("<td style='border: 1px solid #ccc'>");
sb.Append(customer[j]);
sb.Append("</td>");
}
sb.Append("</tr>");
}
//Table end.
sb.Append("</table>");
using (MemoryStream stream = new MemoryStream(Encoding.ASCII.GetBytes(sb.ToString())))
{
ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
PdfWriter writer = new PdfWriter(byteArrayOutputStream);
PdfDocument pdfDocument = new PdfDocument(writer);
pdfDocument.SetDefaultPageSize(PageSize.A4);
HtmlConverter.ConvertToPdf(stream, pdfDocument);
pdfDocument.Close();
return File(byteArrayOutputStream.ToArray(), "application/pdf", "Grid.pdf");
}
}
}
Razor Page (HTML)
Displaying the Records
For displaying the records, an HTML Table is used.
A loop will be executed over the Model which will generate the HTML Table rows with the Customer records.
Exporting database data to PDF File
Below the HTML Table 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 HTML content of the Table to the Razor PageModel.
When the Submit button is clicked, the Form is submitted.
@page
@model Export_Data_Database_PDF_Razor_Core.Pages.IndexModel
@addTagHelper*, Microsoft.AspNetCore.Mvc.TagHelpers
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>Index</title>
</head>
<body>
<h4>Customers</h4>
<hr />
<div id="Grid">
<table cellpadding="5" cellspacing="0" style="border: 1px solid #ccc;">
<tr>
<th style="background-color: #B8DBFD;border: 1px solid #ccc">CustomerID</th>
<th style="background-color: #B8DBFD;border: 1px solid #ccc">ContactName</th>
<th style="background-color: #B8DBFD;border: 1px solid #ccc">City</th>
<th style="background-color: #B8DBFD;border: 1px solid #ccc">Country</th>
</tr>
@foreach (var customer in Model.Customers)
{
<tr>
<td style="border: 1px solid #ccc">@customer.CustomerID</td>
<td style="border: 1px solid #ccc">@customer.ContactName</td>
<td style="border: 1px solid #ccc">@customer.City</td>
<td style="border: 1px solid #ccc">@customer.Country</td>
</tr>
}
</table>
</div>
<br /><br />
<form method="post">
<input type="submit" id="btnSubmit" value="Export" asp-page-handler="Export" />
</form>
</body>
</html>
Screenshots
HTML Table
Exported PDF File
Downloads