Cómo generar un archivo de Excel en Razor Pages

Prerrequisitos

Configurar la creación de archivos de Excel en Razor Pages requiere:

1. Visual Studio (última versión)
2. .NET Framework 6 o 7
3. Aplicación web de .NET Core en Visual Studio

Instalar la biblioteca IronXL

Instalar IronXL usando la consola del Administrador de paquetes NuGet. Introduce este comando para instalar la biblioteca en una aplicación web de .NET Core:

Install-Package IronXL.Excel

Código para generar un archivo Excel

Así es como se escribe el código. Abre "Index.cs" en la carpeta Pages y agrega el siguiente método:

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

En este código, se crea un nuevo WorkBook de Excel que contiene un WorkSheet. La hoja se llena con datos ficticios y el archivo generado se responde al servidor con:

• El WorkBook se convierte en un Stream para descargarse como archivo.
• Se establece el tipo MIME.
• Se especifica un nombre para la descarga del archivo.

Crea un botón para descargar el archivo Excel

Reemplaza el código existente en "Index.cshtml" con lo siguiente:

@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>

Este HTML crea un formulario con asp-page-handler configurado en "Export", lo que permite a la aplicación exportar el archivo de Excel a la máquina local cuando el usuario hace clic en el botón "Generate Excel File!" y se activa una descarga en el navegador.

Ejecutar el proyecto

Ejecuta el proyecto y verás una pantalla en el navegador. Haz clic en el botón verde para descargar el archivo de Excel.

¡Cómo generar un archivo de Excel en Razor Pages, Figura 1: IronXL generar hojas de Excel IronXL generar hojas de Excel

Después de hacer clic en "Generate Excel File!", el archivo se descargará.

¡Cómo generar un archivo de Excel en Razor Pages, Figura 2: IronXL archivo descargado IronXL archivo descargado

Abra el archivo Excel generado

El contenido del archivo de Excel generado coincide con la salida del código con un formato perfecto. La instantánea del archivo de Excel generado se muestra a continuación.

¡Cómo generar un archivo de Excel en Razor Pages, Figura 3: IronXL archivo generado IronXL archivo generado