Razor PagesでExcelファイルを生成する方法

前提条件

Razor PagesでExcelファイルを作成するためのセットアップ要件:

1. Visual Studio（最新バージョン）
2. .NET Framework 6または7
3. Visual Studioでの.NET Core Webアプリケーション

IronXLライブラリのインストール

NuGetパッケージマネージャーコンソールを使用してIronXLをインストール。 .NET Core Webアプリケーションにライブラリをインストールするためにこのコマンドを入力:

Install-Package IronXL.Excel

Excelファイル生成のためのコード

コードの書き方です。 "Index.cs"をPagesフォルダーで開き、次のメソッドを追加:

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");
}

このコードでは、新しいExcel WorkBook が作成され、1つの WorkSheet を含みます。 シートはダミーデータで埋められ、生成されたファイルは以下の方法でサーバーに応答されます:

• WorkBook は Stream に変換され、ファイルとしてダウンロードします。
• MIMEタイプが設定されます。
• ファイルダウンロードの名前が指定されます。

Excelファイルをダウンロードするボタンを作成

"Index.cshtml"の既存のコードを次のもので置き換えます:

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

このHTMLは、asp-page-handler が "Export" に設定されたフォームを作成します。これにより、ユーザーが "Generate Excel File!" ボタンをクリックしてブラウザダウンロードをトリガーすると、アプリケーションはExcelファイルをローカルマシンにエクスポートできます。

プロジェクトの実行

プロジェクトを実行すると、ブラウザに画面が表示されます。 緑のボタンをクリックして、Excelファイルをダウンロードします。

IronXL Excelシート生成

"Generate Excel File!" をクリックした後、ファイルがダウンロードされます。

IronXLダウンロードファイル

生成されたExcelファイルを開く

生成されたExcelファイルの内容は、コードの出力と完璧に一致しています。 生成されたExcelファイルのスナップショットは以下に表示されます。

IronXL生成ファイル