C# 列ヘッダー付きの DataGridView を Excel にエクスポートする

C# で列ヘッダー付きの DataGridView を Excel にエクスポートするにはどうすればよいですか?

Windows フォームの DataGridView コントロールから Excel 形式にデータをエクスポートすることは一般的な要件ですが、開発者はエクスポートされたファイルに列ヘッダーが欠落しているという困難な壁にぶつかることがよくあります。 列ヘッダー付きの DataGridView を Excel にエクスポートする必要がある場合、ソリューションではすべてのデータと書式設定を確実に保持する必要があります。 Microsoft Office Interop を使用する従来のアプローチは、遅く、不安定で、コードを実行するすべてのマシンに MS Excel をインストールする必要があります。

IronXL はこの問題をきれいに解決します。 これは、Office に依存せずに Excel ファイルの読み取り、作成、書き込みを行う.NET Excel ライブラリです。 このチュートリアルでは、列ヘッダー、データ型、null セル、およびユーザーフレンドリーなファイル保存をわずか数行のコードで処理する完全なエクスポート ソリューションについて説明します。

最後に、すべての列ヘッダーをそのままにして DataGridView を XLSX ファイルにエクスポートする、機能的な Windows フォーム ボタン ハンドラーが完成します。

.NETプロジェクトにライブラリをインストールするにはどうすればよいでしょうか?

Visual Studio でNuGetパッケージ マネージャー コンソールを開き、次のいずれかのコマンドを実行します。 このパッケージはNuGetギャラリーに掲載されており、 .NET Standard 2.0 以上を対象としているため、最新 for .NETプロジェクトで動作します。

Install-Package IronXL

Install-Package IronXL

dotnet add package IronXL

dotnet add package IronXL

インストール後、フォーム ファイルの先頭に必要な名前空間を追加します。

using IronXL;
using System;
using System.Data;
using System.Windows.Forms;

using IronXL;
using System;
using System.Data;
using System.Windows.Forms;

これらのインポートにより、IronXL の Excel 機能、DataTable 操作、およびエクスポート プロセスに必要な Windows フォーム コントロールにアクセスできるようになります。

サンプル データを使用して DataGridView を設定するにはどうすればよいですか?

まず、Visual Studio で Windows フォーム アプリケーションを作成します。 デザイナーを使用して、dataGridView1 という名前の DataGridView と btnExport という名前の Button をメイン フォームに追加します。 次に、フォームの読み込み時にグリッドに入力します。

using System;
using System.Data;
using System.Windows.Forms;

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
    }

    private void Form1_Load(object sender, EventArgs e)
    {
        DataTable dt = new DataTable();

        // Define columns -- these names become Excel headers
        dt.Columns.Add("Product ID", typeof(int));
        dt.Columns.Add("Product Name", typeof(string));
        dt.Columns.Add("Price", typeof(decimal));
        dt.Columns.Add("Stock Quantity", typeof(int));

        // Add sample rows
        dt.Rows.Add(1001, "Laptop", 999.99m, 15);
        dt.Rows.Add(1002, "Mouse", 29.99m, 50);
        dt.Rows.Add(1003, "Keyboard", 79.99m, 30);
        dt.Rows.Add(1004, "Monitor", 299.99m, 12);
        dt.Rows.Add(1005, "Headphones", 89.99m, 25);

        // Bind data to the grid
        dataGridView1.DataSource = dt;
    }
}

using System;
using System.Data;
using System.Windows.Forms;

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
    }

    private void Form1_Load(object sender, EventArgs e)
    {
        DataTable dt = new DataTable();

        // Define columns -- these names become Excel headers
        dt.Columns.Add("Product ID", typeof(int));
        dt.Columns.Add("Product Name", typeof(string));
        dt.Columns.Add("Price", typeof(decimal));
        dt.Columns.Add("Stock Quantity", typeof(int));

        // Add sample rows
        dt.Rows.Add(1001, "Laptop", 999.99m, 15);
        dt.Rows.Add(1002, "Mouse", 29.99m, 50);
        dt.Rows.Add(1003, "Keyboard", 79.99m, 30);
        dt.Rows.Add(1004, "Monitor", 299.99m, 12);
        dt.Rows.Add(1005, "Headphones", 89.99m, 25);

        // Bind data to the grid
        dataGridView1.DataSource = dt;
    }
}

dt.Columns.Add(...) 呼び出しで定義された列名は、エクスポートされた Excel ファイルのヘッダー行になります。ここでは任意のデータソースを使用できます。データベースクエリの結果、CSV インポート、または DataTable として保存された API レスポンスなど、いずれも後述のエクスポートコードと同様に機能します。 DataTable アプローチは、DataGridView が任意の IList または IBindingList を受け入れる DataSource プロパティを公開するため、特に便利です。つまり、同じエクスポート コードを変更せずにすべてのバインディング シナリオに一般化できます。

DataGridView が SqlDataAdapter を使用してデータベースから設定されている場合、DataTable には既に型指定された列が含まれています。 これらの入力された値に対して ToString() を呼び出すのではなく SetCellValue に渡すと、Excel 出力で数値列が数値のまま保持されます。これは、下流のレポートやピボット テーブルの使用に重要になります。

これにより、すべてのデータが入力された DataGridView が作成されます。

より高度なデータ バインディング シナリオについては、Microsoft のDataGridView データ バインディングに関するドキュメントに追加の例が提供されています。

列ヘッダーを保持したまま DataGridView を Excel にエクスポートするにはどうすればよいですか?

エクスポート メソッドは、各 DataGridView 列の HeaderText プロパティから列ヘッダーを読み取り、ワークシートの行 0 に書き込みます。 データ行は 1 行目以降に続きます。 このメソッドを btnExport クリック イベントに接続します。

private void btnExport_Click(object sender, EventArgs e)
{
    try
    {
        // Create a new Excel workbook in XLSX format
        WorkBook workbook = WorkBook.Create(ExcelFileFormat.XLSX);
        WorkSheet worksheet = workbook.CreateWorkSheet("Exported Data");

        // Write column headers to row 0
        for (int col = 0; col < dataGridView1.Columns.Count; col++)
        {
            worksheet.SetCellValue(0, col, dataGridView1.Columns[col].HeaderText);
        }

        // Write data rows starting at row 1
        for (int row = 0; row < dataGridView1.Rows.Count; row++)
        {
            // Skip the placeholder new-row at the bottom of the grid
            if (dataGridView1.AllowUserToAddRows && row == dataGridView1.Rows.Count - 1)
                continue;

            for (int col = 0; col < dataGridView1.Columns.Count; col++)
            {
                var cellValue = dataGridView1.Rows[row].Cells[col].Value;
                if (cellValue != null)
                {
                    worksheet.SetCellValue(row + 1, col, cellValue.ToString());
                }
            }
        }

        // Prompt the user to choose a save location
        using SaveFileDialog saveFileDialog = new SaveFileDialog
        {
            Filter = "Excel Files|*.xlsx",
            FileName = "DataGridView_Export.xlsx"
        };

        if (saveFileDialog.ShowDialog() == DialogResult.OK)
        {
            workbook.SaveAs(saveFileDialog.FileName);
            MessageBox.Show("Export completed successfully!", "Success",
                            MessageBoxButtons.OK, MessageBoxIcon.Information);
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show($"Export failed: {ex.Message}", "Error",
                       MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
}

private void btnExport_Click(object sender, EventArgs e)
{
    try
    {
        // Create a new Excel workbook in XLSX format
        WorkBook workbook = WorkBook.Create(ExcelFileFormat.XLSX);
        WorkSheet worksheet = workbook.CreateWorkSheet("Exported Data");

        // Write column headers to row 0
        for (int col = 0; col < dataGridView1.Columns.Count; col++)
        {
            worksheet.SetCellValue(0, col, dataGridView1.Columns[col].HeaderText);
        }

        // Write data rows starting at row 1
        for (int row = 0; row < dataGridView1.Rows.Count; row++)
        {
            // Skip the placeholder new-row at the bottom of the grid
            if (dataGridView1.AllowUserToAddRows && row == dataGridView1.Rows.Count - 1)
                continue;

            for (int col = 0; col < dataGridView1.Columns.Count; col++)
            {
                var cellValue = dataGridView1.Rows[row].Cells[col].Value;
                if (cellValue != null)
                {
                    worksheet.SetCellValue(row + 1, col, cellValue.ToString());
                }
            }
        }

        // Prompt the user to choose a save location
        using SaveFileDialog saveFileDialog = new SaveFileDialog
        {
            Filter = "Excel Files|*.xlsx",
            FileName = "DataGridView_Export.xlsx"
        };

        if (saveFileDialog.ShowDialog() == DialogResult.OK)
        {
            workbook.SaveAs(saveFileDialog.FileName);
            MessageBox.Show("Export completed successfully!", "Success",
                            MessageBoxButtons.OK, MessageBoxIcon.Information);
        }
    }
    catch (Exception ex)
    {
        MessageBox.Show($"Export failed: {ex.Message}", "Error",
                       MessageBoxButtons.OK, MessageBoxIcon.Error);
    }
}

エクスポート中に一般的なエッジケースをどのように処理しますか?

現実世界のデータは、サンプル データセットほどきれいに見えることはほとんどありません。 ここでは、最も遭遇する可能性の高いシナリオとその対処方法を説明します。

if (cellValue is int intVal)
    worksheet.SetCellValue(row + 1, col, intVal);
else if (cellValue is decimal decVal)
    worksheet.SetCellValue(row + 1, col, (double)decVal);
else
    worksheet.SetCellValue(row + 1, col, cellValue?.ToString() ?? string.Empty);

if (cellValue is int intVal)
    worksheet.SetCellValue(row + 1, col, intVal);
else if (cellValue is decimal decVal)
    worksheet.SetCellValue(row + 1, col, (double)decVal);
else
    worksheet.SetCellValue(row + 1, col, cellValue?.ToString() ?? string.Empty);

主な輸出アプローチを比較するとどうなりますか?

ライブラリにコミットする前に、最も一般的な方法間のトレードオフを理解しておくと役立ちます。

相互運用性ベースのソリューションでは、サーバーに Excel がインストールされている必要がありますが、これはライセンスの問題であり、展開も複雑になります。 OpenXML SDK は強力ですが低レベルです。ヘッダー行を書き込むには、XML 構造を手動で構築する必要があります。 IronXLと ClosedXML はどちらもより高レベルの API を提供していますが、IronXL のWorkBook および WorkSheet モデルは、開発者がすでにスプレッドシートについて考えている方法に密接に対応しています。

XLSX ではなく CSV にエクスポートするにはどうすればよいですか?

Excel ブックではなくCSV ファイルが必要な場合も、同じエクスポート パターンが適用されます。 ファイル形式と拡張子を変更します。

WorkBook csvWorkbook = WorkBook.Create(ExcelFileFormat.CSV);
WorkSheet csvSheet = csvWorkbook.CreateWorkSheet("Data");

// Headers and data loops remain identical

using SaveFileDialog dialog = new SaveFileDialog
{
    Filter = "CSV Files|*.csv",
    FileName = "DataGridView_Export.csv"
};

if (dialog.ShowDialog() == DialogResult.OK)
    csvWorkbook.SaveAs(dialog.FileName);

WorkBook csvWorkbook = WorkBook.Create(ExcelFileFormat.CSV);
WorkSheet csvSheet = csvWorkbook.CreateWorkSheet("Data");

// Headers and data loops remain identical

using SaveFileDialog dialog = new SaveFileDialog
{
    Filter = "CSV Files|*.csv",
    FileName = "DataGridView_Export.csv"
};

if (dialog.ShowDialog() == DialogResult.OK)
    csvWorkbook.SaveAs(dialog.FileName);

CSV エクスポートは、消費システムが XLSX をサポートしていない場合や、データセットが非常に大きいためファイル サイズが問題になる場合に役立ちます。

エクスポートしたファイルのヘッダー行のスタイルをどのように設定しますか?

ヘッダー行が視覚的に区別されている場合、エクスポートされたデータは読みやすくなります。 IronXL には、ヘッダー値を書き込んだ後に太字のテキスト、背景色、フォント サイズを適用できるセル スタイル設定オプションが用意されています。

// Write headers and apply bold styling
for (int col = 0; col < dataGridView1.Columns.Count; col++)
{
    string cellAddress = worksheet.GetCellAddress(0, col);
    worksheet[cellAddress].Value = dataGridView1.Columns[col].HeaderText;
    worksheet[cellAddress].Style.Font.Bold = true;
    worksheet[cellAddress].Style.SetBackgroundColor("#4472C4");
    worksheet[cellAddress].Style.Font.FontColor = "#FFFFFF";
}

// Write headers and apply bold styling
for (int col = 0; col < dataGridView1.Columns.Count; col++)
{
    string cellAddress = worksheet.GetCellAddress(0, col);
    worksheet[cellAddress].Value = dataGridView1.Columns[col].HeaderText;
    worksheet[cellAddress].Style.Font.Bold = true;
    worksheet[cellAddress].Style.SetBackgroundColor("#4472C4");
    worksheet[cellAddress].Style.Font.FontColor = "#FFFFFF";
}

スタイル設定されたヘッダー行により、受信者が手動で書式設定を適用する必要がなく、エクスポートされたファイルをすぐにレポートに使用できるようになります。 スタイル プロパティの完全なリストについては、 IronXLセル スタイル リファレンスを参照してください。

無料トライアルを始めるにはどうすればいいですか?

IronXL、この記事で紹介したエクスポート ワークフローを含むすべての機能をテストできる無料トライアルを提供しています。 上記のいずれかのNuGetコマンドを使用してパッケージをインストールし、 IronXLライセンス ページで試用キーを生成して、最初のライブラリ呼び出しの前にアプリケーションに設定します。

IronXl.License.LicenseKey = "YOUR-LICENSE-KEY-HERE";

IronXl.License.LicenseKey = "YOUR-LICENSE-KEY-HERE";

試用版では、完全に機能する Excel ファイルが生成され、利用できる機能が制限されることはありません。 実稼働展開の場合、ライセンス オプションには、単一の開発者、チーム、ロイヤリティフリーの再配布が含まれます。

関連するエクスポート シナリオについては、 IronXL がDataTables を Excel に直接エクスポートし、 Excel ファイルを DataGridViews に読み込み、エクスポートされたデータからグラフを作成する方法について説明します。