使用 C# 将 DataTable 转换为专业的 PDF 报表

sales@e-iceblue.com

028-81705109

2790765778

微信扫一扫

论坛

Spire.Cloud 纯前端文档控件

帮助文档
表格
使用 C# 将 DataTable 转换为专业的 PDF 报表

使用 C# 将 DataTable 转换为专业的 PDF 报表

使用 C# 将 DataTable 导出为 PDF 的教程封面

在许多基于 .NET 的业务系统中，结构化数据通常以 DataTable 的形式存在。当这些数据需要被分发、归档，或以只读报表的形式对外提供时，使用 C# 将 DataTable 导出为 PDF 就成为一个非常常见且实用的需求。

与 Excel、CSV 等格式相比，PDF 更适合那些更关注版式稳定性、视觉一致性和文档完整性的场景，而不是数据的可编辑性。因此，PDF 特别适用于报表、发票、审计记录以及系统自动生成的正式文档。

本文采用以代码为核心的方式，讲解如何在 C# 中将 DataTable 转换为 PDF，重点放在具体实现细节上。示例基于 Spire.PDF for .NET，并使用其中的 PdfGrid 组件，将 DataTable 的内容以结构化表格的形式渲染到 PDF 文档中。

1. 概览：C# 中的 DataTable 导出为 PDF
2. 环境准备
3. 核心流程与代码实现
4. 表格布局、页面流与分页控制
5. 表格样式自定义
6. PDF 输出方式：文件与流
7. 实用技巧与常见问题

1. 概览：C# 中将 DataTable 导出为 PDF

从本质上看，将 DataTable 导出为 PDF 是一个数据绑定 + 渲染的问题，而不是一个底层绘图问题。

也就是说，你并不需要手动计算每一行的位置、列宽，或自己处理分页逻辑。更合理的做法是：将现有的 DataTable 直接绑定到一个 PDF 表格组件上，由渲染引擎自动完成布局和分页。

在 Spire.PDF for .NET 中，这个角色正是由 PdfGrid 类来承担的。

为什么 PdfGrid 是合适的抽象层

PdfGrid 是 Spire.PDF for .NET 中的一个类，用于在 PDF 文档中显示结构化表格数据。它将“行、列、表头、分页”等概念作为核心概念来处理，而不仅仅是进行图形绘制操作。

从技术角度来看，PdfGrid 提供了以下关键能力：

通过 DataSource 属性直接绑定 DataTable
根据 DataTable 的结构自动生成列
内置表头与数据行的渲染逻辑
当内容超出页面范围时自动分页

因此，将 DataTable 导出为 PDF 更像是一种声明式操作：你只需要说明“要渲染哪些数据”，而具体“如何在页面中排版和分页”，则交由 PDF 引擎自动完成。

接下来的章节将围绕这一思路，重点讲解具体实现方式以及在实际项目中常见的优化细节。

2. 环境准备

本文中的所有示例代码同时适用于 .NET Framework 和现代 .NET（6 及以上） 项目。整个实现完全基于托管代码，不需要任何平台相关的额外配置。

安装 Spire.PDF for .NET

可以通过 NuGet 安装 Spire.PDF for .NET：

Install-Package Spire.PDF

你也可以直接下载 Spire.PDF for .NET，并手动将其添加到项目中。

安装完成后，该库将提供完整的 PDF 文档创建、页面管理、表格渲染以及样式控制 API。

3. C# 中将 DataTable 导出为 PDF：核心流程与代码实现

在环境准备完成后，将 DataTable 导出为 PDF 就变成了一个线性、以实现为导向的过程。

核心思想是：将现有的 DataTable 绑定到 PdfGrid，并将布局、分页和表格绘制的职责全部交给 PDF 引擎处理，而不是手动绘制行、列或边框。

从实现角度来看，整个流程通常包含以下几个步骤：

准备一个已填充数据的 DataTable
创建 PDF 文档和页面
将 DataTable 绑定到 PdfGrid
将表格绘制到页面上
保存 PDF 输出结果

注意：如果 DataTable 中包含中文字符，默认字体可能无法渲染，导致 PDF 显示空白。因此在渲染前应使用支持中文的基础字体（如“微软雅黑”或“宋体”），并通过 PdfTrueTypeFont 应用到表格样式中。

在真实项目中，这些步骤通常会在同一段代码流程中顺序执行。下面的示例代码展示了一个完整、可直接使用的实现。

完整示例：将 DataTable 导出为 PDF

以下示例使用了一个偏业务报表风格的 DataTable 结构，以贴近实际应用场景。需要注意的是，DataTable 的数据来源（数据库、API 或内存计算）并不会影响导出逻辑本身。

using Spire.Pdf;
using Spire.Pdf.Graphics;
using Spire.Pdf.Grid;
using System.Data;
using System.Drawing;

DataTable dataTable = new DataTable();
dataTable.Columns.Add("OrderId", typeof(int));
dataTable.Columns.Add("CustomerName", typeof(string));
dataTable.Columns.Add("OrderDate", typeof(DateTime));
dataTable.Columns.Add("TotalAmount", typeof(decimal));

// 使用国内常见企业或品牌，金额也贴近实际业务
dataTable.Rows.Add(1001, "京东商城", DateTime.Today, 1580.75m);
dataTable.Rows.Add(1002, "天猫超市", DateTime.Today, 890.50m);
dataTable.Rows.Add(1003, "苏宁易购", DateTime.Today, 2340.00m);
dataTable.Rows.Add(1004, "小米官方商城", DateTime.Today, 1760.20m);
dataTable.Rows.Add(1005, "拼多多", DateTime.Today, 1120.00m);
dataTable.Rows.Add(1006, "国美在线", DateTime.Today, 980.30m);

PdfDocument document = new PdfDocument();
PdfPageBase page = document.Pages.Add();

PdfGrid grid = new PdfGrid();
grid.DataSource = dataTable;

// 应用包含中文的字体以防止文字丢失
PdfGridCellStyle cellStyle = new PdfGridCellStyle();
cellStyle.Font = new PdfTrueTypeFont(new Font("微软雅黑", 9f), true);
grid.Rows.ApplyStyle(cellStyle);

grid.Draw(page, new PointF(0, 40f));

document.SaveToFile("DataTableToPDF.pdf");
document.Close();

这段代码已经完成了 DataTable → PDF 的完整导出流程。下面是生成的 PDF 文件效果预览：

使用 C# 从 DataTable 生成的 PDF 文档

该实现的关键技术特点包括：

PdfGrid.DataSource 可直接接收 DataTable，无需手动映射行或列
表头会自动使用 DataColumn.ColumnName 生成
数据行来自每一条 DataRow
分页与换页逻辑在渲染阶段自动完成
无需编写任何基于坐标的表格布局代码

最终生成的 PDF 是一个结构清晰、支持分页的表格文档，能够准确反映 DataTable 的结构和数据内容。在多数场景下，这种方式已经是一个可直接用于生产环境的解决方案。

当然，在实际项目中，通常还会对表格的位置、页面大小、方向以及样式提出更高要求。接下来的章节将重点介绍如何在不改变核心导出逻辑的前提下，对布局、分页和视觉效果进行精细控制。

4. 表格布局、页面流与分页控制

在真实的业务文档中，表格通常只是页面内容的一部分。页面尺寸、表格起始位置以及分页方式，共同决定了表格数据在一页或多页中的呈现效果。

在 PdfGrid 中，这些问题并不是由表格本身单独管理的，而是在创建页面时以及调用 Draw 方法进行渲染时解决。PdfGrid 不直接负责页面切换或绝对定位，真正起作用的是页面配置以及绘制时传入的参数。

下面的示例展示了在实际报表中非常常见的一种布局与分页配置方式。

布局与分页示例

PdfDocument document = new PdfDocument();

// 创建 A4 页面并设置页边距
PdfPageBase page = document.Pages.Add(
    PdfPageSize.A4,
    new PdfMargins(40),
    PdfPageRotateAngle.RotateAngle0, // 页面坐标系旋转角度
    PdfPageOrientation.Landscape     // 页面方向：横向
);

PdfGrid grid = new PdfGrid();
grid.DataSource = dataTable;

// 启用跨页重复表头
grid.RepeatHeader = true;

// 定义表格起始绘制位置
float startX = 40f;
float startY = 80f;

// 应用包含中文的字体以防止文字丢失
PdfGridCellStyle cellStyle = new PdfGridCellStyle();
cellStyle.Font = new PdfTrueTypeFont(new Font("微软雅黑", 9f), true);
grid.Rows.ApplyStyle(cellStyle);

// 绘制表格
grid.Draw(page, new PointF(startX, startY));

应用页面配置后的 PDF 效果如下：

应用页面配置后的 DataTable PDF 示例

技术说明

上述渲染行为可以理解为在绘制阶段依次应用的一系列布局与页面流规则：

PdfPageBase
- 通过 Pages.Add 创建新页面，并可配置页面尺寸、页边距、旋转角度和方向。
RepeatHeader
- 控制是否在多页表格中自动重复渲染列标题。
- 启用后，当表格跨页时，表头会在每一页自动显示。
Draw 方法
- 接收一个 PointF 参数，用于指定表格在页面中的起始位置。
- 在绘制过程中自动处理分页和内容溢出问题。

通过对页面几何属性、表格起始位置和分页行为的统一配置，PdfGrid 能够在无需手动控制分页或逐行布局的情况下，稳定地生成多页表格文档。

在实际的 PDF 报表中，页码通常也是必不可少的组成部分。如果你需要为 PDF 添加页码，可以参考：如何使用 C# 为 PDF 添加页码。

5. 表格样式自定义

在布局稳定之后，下一步通常就是对表格外观进行控制。PdfGrid 提供了一套集中式的样式模型，可以在不影响数据绑定和分页逻辑的前提下，对整个表格、列或行进行样式定制。

下面的示例整合了在报表类场景中最常见的一些样式设置方式。

样式示例：表头、行与列

PdfDocument document = new PdfDocument();
PdfPageBase page = document.AppendPage();

PdfGrid grid = new PdfGrid();
grid.DataSource = dataTable;

// 创建并应用表头样式
PdfGridCellStyle headerStyle = new PdfGridCellStyle();
headerStyle.Font =
    new PdfFont(PdfFontFamily.Helvetica, 10f, PdfFontStyle.Bold);
headerStyle.BackgroundBrush =
    new PdfSolidBrush(Color.FromArgb(60, 120, 200));
headerStyle.TextBrush = PdfBrushes.White;
grid.Headers.ApplyStyle(headerStyle);

// 创建行样式
PdfGridCellStyle defaultStyle = new PdfGridCellStyle();
defaultStyle.Font = new PdfTrueTypeFont(new Font("微软雅黑", 9f), true);
PdfGridCellStyle alternateStyle = new PdfGridCellStyle();
alternateStyle.BackgroundBrush =
    new PdfSolidBrush(Color.LightSkyBlue);
alternateStyle.Font = new PdfTrueTypeFont(new Font("微软雅黑", 10f), true);

// 应用行样式（隔行变色）
for (int rowIndex = 0; rowIndex < grid.Rows.Count; rowIndex++)
{
    if (rowIndex % 2 == 0)
    {
        grid.Rows[rowIndex].ApplyStyle(defaultStyle);
    }
    else
    {
        grid.Rows[rowIndex].ApplyStyle(alternateStyle);
    }
}

// 明确设置列宽
grid.Columns[0].Width = 60f;   // OrderId
grid.Columns[1].Width = 140f;  // CustomerName
grid.Columns[2].Width = 90f;   // OrderDate
grid.Columns[3].Width = 90f;   // TotalAmount

// 绘制表格
grid.Draw(page, new PointF(40f, 80f));

应用上述样式后的 PDF 效果如下：

应用样式后的 DataTable PDF 文档

样式行为说明

表头样式
- 表头样式通过独立的 PdfGridCellStyle 定义，并使用 grid.Headers.ApplyStyle(...) 统一应用。
- 这种方式可以确保表头在多页文档中保持一致的字体、背景色和文本颜色。
数据行样式
- 数据行通过 grid.Rows[i].ApplyStyle(...) 明确设置样式。
- 利用行索引实现隔行变色，逻辑清晰，也便于后续扩展更复杂的条件判断。
列宽控制
- 列宽可通过 grid.Columns[index].Width 显式指定。
- 明确的列宽可以避免因内容长度不同导致的布局抖动，更适合报表类文档。

注意：样式必须在调用 grid.Draw(...) 之前设置完成。

所有样式（表头、行、列）都会在渲染前统一解析，并在绘制过程中生效，不会影响分页或数据绑定逻辑。

如果你需要更复杂的表格样式控制（例如边框、对齐方式或条件样式），可以参考：使用 C# 创建并美化 PDF 表格。

6. PDF 输出方式：文件与流

当表格完成渲染后，最后一步就是导出 PDF 结果。无论输出到文件还是写入流中，表格的生成与渲染逻辑都是完全一致的，区别只在于输出目标。

6.1 保存为文件

将 PDF 直接保存为文件，适合桌面应用、后台任务以及批量导出等场景。

document.SaveToFile("DataTableReport.pdf");
document.Close();

这种方式通常用于：

Windows 桌面应用程序
定时生成报表的后台服务
离线处理或服务器端批量任务

6.2 写入流（Web / API 场景）

在 Web 系统中，通常不希望或不需要将 PDF 写入磁盘。此时，可以直接将 PDF 内容写入内存流，再作为响应返回给客户端。

using (MemoryStream stream = new MemoryStream())
{
    document.SaveToStream(stream);
    document.Close();

    byte[] pdfBytes = stream.ToArray();
    // 将 pdfBytes 作为 HTTP 响应返回
}

这种方式可以很好地与 ASP.NET 控制器或 Minimal API 集成，无需创建任何临时文件。

如果你需要一个完整的 Web 示例，可以参考：在 ASP.NET 中创建并返回 PDF 文档。

7. 实用技巧与常见问题

本节总结了在实际项目中，将 DataTable 导出为 PDF 时最容易遇到的一些问题及处理建议。

7.1 日期与数值格式控制

PdfGrid 会直接使用数据的字符串表示形式进行渲染。因此，如果对格式有要求，应该在绑定之前对数据进行统一处理。

常见场景包括：

使用固定文化信息（Culture）格式化 DateTime
统一金额或数值的小数位数
在多地区系统中避免使用依赖区域设置的格式

这些工作应当放在数据层完成，而不是在渲染阶段临时处理。

7.2 处理空值与 DBNull

如果 DataTable 中包含 DBNull.Value，可能会导致单元格内容为空或布局不一致。

在绑定之前对数据进行规范化，可以避免这些问题：

row["TotalAmount"] =
    row["TotalAmount"] == DBNull.Value ? 0m : row["TotalAmount"];

这种做法可以让渲染逻辑保持简单、可预期。

7.3 防止表格宽度超出页面

当 DataTable 的列较多或列内容较宽时，如果不做控制，表格很容易超出页面宽度。

常见的解决方式包括：

明确设置每一列的宽度
适当减小字体大小
将页面方向切换为横向
针对性地调整页边距

这些调整应当在布局层完成，而不是通过修改原始数据来规避问题。

7.4 大数据量 DataTable 的性能考虑

当 DataTable 包含数百甚至上千行数据时，性能差异会变得更加明显。

实践中的一些建议包括：

避免对每个单元格或每一行单独设置样式
尽量使用表级或列级样式
优先使用系统内置字体，避免嵌入自定义字体
保持布局计算逻辑简单且一致

例如，在大数据量场景下，在循环中频繁调用 grid.Rows[rowIndex].ApplyStyle(...) 可能会带来不必要的性能开销。如果不需要对每一行进行差异化处理，更推荐使用 grid.Rows.ApplyStyle(...) 这样的方式一次性应用统一样式。

此外，在 Web 环境中，PDF 生成过程最好放在请求线程之外执行，以避免阻塞请求处理。

8. 总结

在 C# 中，将 DataTable 导出为 PDF 并不需要手动构建表格或进行底层绘图操作。通过 PdfGrid 直接绑定现有的 DataTable，就可以生成支持自动分页的 PDF 表格，同时对布局和外观保持良好的控制能力。

本文从实际开发角度出发，重点介绍了导出流程、布局定位、样式设置以及数据准备等关键问题。这套模式既适用于简单报表，也能够平滑扩展到多页、大数据量的复杂文档场景。

如果你计划在真实项目中评估或使用该方案，可以通过 E-ICEBLUE 申请临时许可证，以不受限制地测试完整功能。

常见问题解答

什么时候适合使用 PdfGrid 导出 DataTable？

当你需要生成结构清晰、支持分页且版式稳定的表格型 PDF 文档时，PdfGrid 是非常合适的选择。它能够自动处理列生成、表头和分页问题，相比手动绘制，更适合报表、发票和审计类文档。

数据格式化应该在 DataTable 还是 PdfGrid 中完成？

数据规范化（如日期格式、数值精度、空值处理）应在绑定之前完成。 PdfGrid 更适合负责布局和视觉样式，而不是数据转换。

PdfGrid 能高效处理大规模 DataTable 吗？

可以。PdfGrid 支持自动分页和表头重复显示。在大数据量场景下，避免逐行或逐单元格设置样式，而是使用表级或列级样式，有助于保持良好的性能表现。

返回顶部

使用 C# 将 DataTable 转换为专业的 PDF 报表

1. 概览：C# 中将 DataTable 导出为 PDF

为什么 PdfGrid 是合适的抽象层

2. 环境准备

安装 Spire.PDF for .NET

3. C# 中将 DataTable 导出为 PDF：核心流程与代码实现

完整示例：将 DataTable 导出为 PDF

4. 表格布局、页面流与分页控制

布局与分页示例

技术说明

5. 表格样式自定义

样式示例：表头、行与列

样式行为说明

6. PDF 输出方式：文件与流

6.1 保存为文件

6.2 写入流（Web / API 场景）

7. 实用技巧与常见问题

7.1 日期与数值格式控制

7.2 处理空值与 DBNull

7.3 防止表格宽度超出页面

7.4 大数据量 DataTable 的性能考虑

8. 总结

常见问题解答

什么时候适合使用 PdfGrid 导出 DataTable？

数据格式化应该在 DataTable 还是 PdfGrid 中完成？

PdfGrid 能高效处理大规模 DataTable 吗？

相关文章