How to Generate an Excel File on Razor Pages
Razor Pages offer a modern approach to building web pages. In Razor Pages, the source code that renders the web page is written in C# rather than being generated by a server-side page.
To efficiently work with Excel files, the IronXL library is recommended over others like the POI Java project NPOI package (notably used with PowerPoint files) and Office Interop. IronXL is a feature-rich, easy-to-use library that doesn't require Microsoft Office and supports multiple .NET versions.
This article demonstrates using the IronXL C# library to generate and export Excel spreadsheets with dummy data and row headers in Razor Pages.
How to Generate Excel Files in Razor Pages
- Install C# library to generate Excel files in Razor
- Access or create a new Excel file in a method
- Add data and style to the WorkBook object in Razor
- Use File method to automatically download Excel file when the button is pressed
- Inspect the generated Excel file
IronXL: C# Excel Library
IronXL is a C# Excel library that offers methods and functions for operating on large data sets using parallel processing to increase computing power. It's user-friendly as it doesn't require understanding the inner workings and supports both XLS and XLSX files.
IronXL is ideal for importing, exporting, creating Excel formulas, and office documents without needing Microsoft Office to be installed.
Learn how to import and export Excel files in Razor Pages using IronXL.
Generate Excel File in Razor Pages
To create Excel sheets in Razor Pages, start by opening Visual Studio, creating an ASP.NET Core Web Application, and installing IronXL.
Prerequisites
Setting up to create Excel files in Razor Pages requires:
- Visual Studio (Latest Version)
- .NET Framework 6 or 7
- .NET Core Web Application in Visual Studio
Install IronXL Library
Install IronXL using the NuGet Package Manager Console. Enter this command to install the library in a .NET Core Web Application:
Install-Package IronXL.Excel
Code for Generating Excel file
Here's how to write the code. Open "Index.cs" in the Pages folder and add the following method:
public FileResult OnPostExport()
{
// Create a new WorkBook with XLSX format
WorkBook workBook = new WorkBook(IronXL.ExcelFileFormat.XLSX);
// Create a new WorkSheet named "data"
WorkSheet workSheet = workBook.CreateWorkSheet("data");
// Add headers to the new worksheet
workSheet["A1"].Value = "Product EN";
workSheet["B1"].Value = "SKU";
workSheet["C1"].Value = "Customer";
// Make header text bold
workSheet["A1:C1"].Style.Font.Bold = true;
// Add dummy data to the worksheet
workSheet["A2"].Value = "Iron Rods";
workSheet["A3"].Value = "Mobile Phones";
workSheet["A4"].Value = "Chargers";
workSheet["B2"].Value = "105";
workSheet["B3"].Value = "285";
workSheet["B4"].Value = "301";
workSheet["C2"].Value = "Adam";
workSheet["C3"].Value = "Ellen";
workSheet["C4"].Value = "Tom";
// Convert the WorkBook to a byte array Stream for download
return File(workBook.ToStream().ToArray(), "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "Grid.xlsx");
}
public FileResult OnPostExport()
{
// Create a new WorkBook with XLSX format
WorkBook workBook = new WorkBook(IronXL.ExcelFileFormat.XLSX);
// Create a new WorkSheet named "data"
WorkSheet workSheet = workBook.CreateWorkSheet("data");
// Add headers to the new worksheet
workSheet["A1"].Value = "Product EN";
workSheet["B1"].Value = "SKU";
workSheet["C1"].Value = "Customer";
// Make header text bold
workSheet["A1:C1"].Style.Font.Bold = true;
// Add dummy data to the worksheet
workSheet["A2"].Value = "Iron Rods";
workSheet["A3"].Value = "Mobile Phones";
workSheet["A4"].Value = "Chargers";
workSheet["B2"].Value = "105";
workSheet["B3"].Value = "285";
workSheet["B4"].Value = "301";
workSheet["C2"].Value = "Adam";
workSheet["C3"].Value = "Ellen";
workSheet["C4"].Value = "Tom";
// Convert the WorkBook to a byte array Stream for download
return File(workBook.ToStream().ToArray(), "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "Grid.xlsx");
}
Public Function OnPostExport() As FileResult
' Create a new WorkBook with XLSX format
Dim workBook As New WorkBook(IronXL.ExcelFileFormat.XLSX)
' Create a new WorkSheet named "data"
Dim workSheet As WorkSheet = workBook.CreateWorkSheet("data")
' Add headers to the new worksheet
workSheet("A1").Value = "Product EN"
workSheet("B1").Value = "SKU"
workSheet("C1").Value = "Customer"
' Make header text bold
workSheet("A1:C1").Style.Font.Bold = True
' Add dummy data to the worksheet
workSheet("A2").Value = "Iron Rods"
workSheet("A3").Value = "Mobile Phones"
workSheet("A4").Value = "Chargers"
workSheet("B2").Value = "105"
workSheet("B3").Value = "285"
workSheet("B4").Value = "301"
workSheet("C2").Value = "Adam"
workSheet("C3").Value = "Ellen"
workSheet("C4").Value = "Tom"
' Convert the WorkBook to a byte array Stream for download
Return File(workBook.ToStream().ToArray(), "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "Grid.xlsx")
End Function
In this code, a new Excel WorkBook
is created and contains one WorkSheet
. The sheet is populated with dummy data, and the generated file is responded to the server with:
- The
WorkBook
is converted to aStream
to download as a file. - The MIME type is set.
- A name for the file download is specified.
Create a button to download the Excel file
Replace the existing code in "Index.cshtml" with the following:
@page
@model IndexModel
@{
ViewData["Title"] = "Home page";
}
<div class="text-center">
<h1 class="display-4">IronXL Generate Excel File</h1>
<p class="m-5">IronXL is an Excel Library for C# that allows developers to read and edit Excel data from XLS and XLSX documents without using Microsoft.Office.Interop.Excel</p>
<form method="post" asp-page-handler="Export">
<button class="btn btn-success p-3">Generate Excel File!</button>
</form>
</div>
@page
@model IndexModel
@{
ViewData["Title"] = "Home page";
}
<div class="text-center">
<h1 class="display-4">IronXL Generate Excel File</h1>
<p class="m-5">IronXL is an Excel Library for C# that allows developers to read and edit Excel data from XLS and XLSX documents without using Microsoft.Office.Interop.Excel</p>
<form method="post" asp-page-handler="Export">
<button class="btn btn-success p-3">Generate Excel File!</button>
</form>
</div>
This HTML creates a form with asp-page-handler
set to "Export", enabling the application to export the Excel file to the local machine when the user clicks the "Generate Excel File!" button, triggering a browser download.
Run the Project
Run the project, and you'll see a screen in the browser. Click the green button to download the Excel file.
IronXL Generate Excel Sheets
After clicking "Generate Excel File!", the file will download.
IronXL Downloaded File
Open the Generated Excel File
The generated Excel file's content matches the code's output with perfect formatting. The snapshot of the generated Excel file is displayed below.
IronXL Generated File
IronXL better than Competitors
IronXL is a superior tool for working with both XLS and XLSX formats without limitations like NPOI, which is slower due to being Java-based, whereas IronXL is C#. In ASP.NET Core applications generating large/multiple spreadsheets, opt for IronXL over POI.
IronXL allows for creating and editing Excel files without Microsoft Office. Unlike Microsoft Interop, IronXL does not need to call Microsoft Excel's ActiveX for Excel operations or exports. It also allows exporting CSV files to Excel format.
IronXL also provides extensive features for interacting with Excel files, including converting between popular formats, inserting math functions, adding charts, and inserting images.
Conclusion
This article showcases using IronXL for generating an Excel file in Razor Pages without needing Microsoft Excel ActiveX and facilitating file downloads.
Explore more tutorials on creating Excel files.
IronXL is free for non-commercial development. A free trial is available for production testing. View pricing plans for more pricing and licensing details.
Frequently Asked Questions
What is this C# Excel library?
IronXL is a C# Excel library that allows users to create, read, and edit Excel files without needing Microsoft Office. It supports both XLS and XLSX formats and offers features like parallel processing for large datasets.
How do I install the library for Excel file generation in a Razor Pages project?
You can install IronXL using the NuGet Package Manager Console in Visual Studio. Use the command: Install-Package IronXL.Excel.
Can I generate Excel files in Razor Pages without Microsoft Office?
Yes, you can generate Excel files in Razor Pages without Microsoft Office using the IronXL library, which does not require Office Interop or ActiveX components.
What are the prerequisites for generating Excel files in Razor Pages?
You need Visual Studio, the latest version of the .NET Framework (6 or 7), and a .NET Core Web Application setup in Visual Studio.
How do I generate an Excel file in Razor Pages?
Create a new WorkBook using the IronXL library, add data to a WorkSheet, and convert the WorkBook to a byte array stream for download using the File method in your Razor Pages code.
Does the library support exporting data to formats other than Excel?
Yes, IronXL allows exporting CSV files to Excel format and provides features for converting between various popular spreadsheet formats.
Is this library better than other libraries like NPOI?
IronXL is considered superior for C# applications because it operates faster than Java-based libraries like NPOI, doesn't require Microsoft Office, and offers extensive features for Excel file manipulation.
Can the library handle large datasets efficiently?
Yes, IronXL offers methods and functions for operating on large datasets using parallel processing, which increases computing power and efficiency.
Is there a free trial available for this library?
Yes, IronXL offers a free trial for production testing and is free for non-commercial development. Pricing plans are available for commercial use.