当前位置：首页 > news >正文

【C#生态园】构建高效PDF应用：全面解析C#六大PDF生成库

news 来源：原创 2024/9/27 5:21:36

选择最适合你的C# PDF生成库：全方位对比

前言

在C#开发中，生成和处理PDF文件是一个常见的需求。为了满足这一需求，开发人员可以利用现有的PDF生成库和处理工具。本文将介绍六种流行的用于C#的PDF生成库，包括iTextSharp、PdfSharp、EO.Pdf、Apache PDFBox、MigraDoc和Spire.PDF。通过对这些库的功能、安装配置以及API概览进行全面的介绍，旨在帮助开发人员选择适合其项目需求的工具。

欢迎订阅专栏：C#生态园

文章目录

选择最适合你的C# PDF生成库：全方位对比
- 前言
- 1. iTextSharp：一个用于C#的PDF生成库
- - 1.1 简介
  - - 1.1.1 核心功能
    - 1.1.2 使用场景
  - 1.2 安装与配置
  - - 1.2.1 安装指南
    - 1.2.2 基本配置
  - 1.3 API 概览
  - - 1.3.1 PDF文档创建
    - 1.3.2 页面设计
- 2. PdfSharp：一个用于C#的PDF生成库
- - 2.1 简介
  - - 2.1.1 核心功能
    - 2.1.2 使用场景
  - 2.2 安装与配置
  - - 2.2.1 安装方法
    - 2.2.2 基本设置
  - 2.3 API 概览
  - - 2.3.1 PDF 页面布局
    - 2.3.2 图形绘制
- 3. EO.Pdf：C#中用于HTML转换为PDF的库
- - 3.1 简介
  - - 3.1.1 核心功能
    - 3.1.2 使用场景
  - 3.2 安装与配置
  - - 3.2.1 安装指南
    - 3.2.2 初始配置
  - 3.3 API 概览
  - - 3.3.1 HTML转PDF
    - 3.3.2 自定义样式
- 4. Apache PDFBox：C#中处理PDF文件的库
- - 4.1 简介
  - - 4.1.1 核心功能
    - 4.1.2 使用场景
  - 4.2 安装与配置
  - - 4.2.1 安装指导
    - 4.2.2 初始设置
  - 4.3 API 概览
  - - 4.3.1 PDF内容提取
    - 4.3.2 文档操作
- 5. MigraDoc：用于创建PDF和RTF文档的C#库
- - 5.1 简介
  - - 5.1.1 核心功能
    - 5.1.2 使用场景
  - 5.2 安装与配置
  - - 5.2.1 安装指引
    - 5.2.2 基本配置
  - 5.3 API 概览
  - - 5.3.1 文档结构设计
    - 5.3.2 样式定义
- 6. Spire.PDF：C#中处理PDF文件的全功能库
- - 6.1 简介
  - - 6.1.1 核心功能
    - 6.1.2 使用场景
  - 6.2 安装与配置
  - - 6.2.1 安装方法
    - 6.2.2 基本设置
  - 6.3 API 概览
  - - 6.3.1 PDF编辑
    - 6.3.2 加密解密
- 总结

1. iTextSharp：一个用于C#的PDF生成库

iTextSharp 是一个用于C#的开源PDF生成库，可以用来创建、编辑和处理PDF文档。

1.1 简介

1.1.1 核心功能

iTextSharp 可以帮助用户在C#环境下实现以下核心功能：

创建 PDF 文档
添加页面内容（如文本、图片和表格）
设置页面布局和样式
加密和解密 PDF 文件
提取和操作已有 PDF 文件的内容

1.1.2 使用场景

iTextSharp 在以下场景中非常实用：

自动生成报表和证件
动态填充PDF表单
创建可打印的文件

1.2 安装与配置

1.2.1 安装指南

通过NuGet管理器可以很容易地安装iTextSharp包。你可以在Visual Studio中搜索并安装"itext7"。

Install-Package itext7

要了解更多关于iTextSharp的安装方法，请参考官方文档

1.2.2 基本配置

安装之后，只需在C#项目中引用iTextSharp库即可开始使用。

1.3 API 概览

1.3.1 PDF文档创建

以下是一个简单的示例代码，演示了如何使用iTextSharp创建一个PDF文档：

using iText.Kernel.Pdf;
using iText.Layout;
using iText.Layout.Element;
using System;namespace PdfExample
{class Program{static void Main(string[] args){string dest = "HelloWorld.pdf";var writer = new PdfWriter(dest);var pdf = new PdfDocument(writer);var document = new Document(pdf);document.Add(new Paragraph("Hello World!"));document.Close();}}
}

上述代码创建了一个名为"HelloWorld.pdf"的PDF文件，并向其中添加了一行文本：“Hello World!”。更多关于PDF文档的内容创建方法，请参考创建 PDF 文档

1.3.2 页面设计

iTextSharp可以帮助用户设计PDF页面，例如设置页面大小、页边距和背景颜色等。以下是一个简单的示例代码，演示了如何使用iTextSharp设计PDF页面：

using iText.Kernel.Pdf;
using iText.Layout;
using iText.Layout.Properties;
using iText.Layout.Borders;
using iText.Kernel.Color;namespace PdfExample
{class Program{static void Main(string[] args){string dest = "PageDesignExample.pdf";var writer = new PdfWriter(dest);var pdf = new PdfDocument(writer);var document = new Document(pdf);document.SetMargins(36, 36, 36, 36);document.SetBackgroundColor(Color.LIGHT_GRAY);document.Add(new Paragraph("This is a PDF page with custom design."));document.Close();}}
}

上述代码创建了一个自定义设计的PDF页面，并将其保存为"PageDesignExample.pdf"。更多关于页面设计的方法，请参考设计 PDF 页面

2. PdfSharp：一个用于C#的PDF生成库

PdfSharp 是一个用于 C# 的开源 PDF 生成库，可以帮助开发人员轻松地创建和修改 PDF 文档。本文将介绍 PdfSharp 的基本信息、安装配置方法以及 API 概览。

2.1 简介

2.1.1 核心功能

PdfSharp 提供了丰富的功能来生成和处理 PDF 文档，包括创建新文档、添加页面、插入图像和文本等操作。此外，它还支持页面布局、字体设置、表格渲染等功能。

2.1.2 使用场景

PdfSharp 可以广泛应用于需要动态生成 PDF 文档的场景，比如报表生成、发票打印、电子书制作等。

2.2 安装与配置

2.2.1 安装方法

可通过 NuGet 包管理器安装 PdfSharp 库，或者从官方网站下载最新版本的压缩包进行手动安装。

// 通过 NuGet 安装
Install-Package PdfSharp// 或手动安装
// 下载地址：https://www.nuget.org/packages/PDFsharp/

2.2.2 基本设置

安装完成后，在项目中引用 PdfSharp 名称空间，即可开始使用 PdfSharp 的功能。

using PdfSharp;

2.3 API 概览

2.3.1 PDF 页面布局

PdfSharp 提供了丰富的页面布局功能，以下是一个简单的示例代码，用于创建一个包含文本的 PDF 文档：

// 创建一个新的 PDF 文档
PdfDocument document = new PdfDocument();// 添加一个页面
PdfPage page = document.AddPage();
XGraphics gfx = XGraphics.FromPdfPage(page);
XFont font = new XFont("Verdana", 20, XFontStyle.Bold);// 绘制文本到页面
gfx.DrawString("Hello, PDF!", font, XBrushes.Black,new XRect(0, 0, page.Width, page.Height),XStringFormats.Center);// 保存文档
string filename = "HelloWorld.pdf";
document.Save(filename);

官方链接：PdfSharp - PDF 页面布局

2.3.2 图形绘制

除了文本之外，PdfSharp 还支持图形的绘制，例如绘制直线、矩形和椭圆等。以下是一个简单的绘制直线的示例代码：

// 绘制一条直线
gfx.DrawLine(XPens.Red, 10, 10, 100, 100);

官方链接：PdfSharp - 图形绘制

3. EO.Pdf：C#中用于HTML转换为PDF的库

EO.Pdf 是一个 C# 库，可以帮助开发人员将 HTML 内容转换为 PDF 格式。这篇文章将介绍 EO.Pdf 的简介、安装与配置以及 API 概览。

3.1 简介

3.1.1 核心功能

EO.Pdf 提供了将包含 HTML 内容的文件转换为 PDF 格式的功能。它能够处理 HTML 中的图像、样式和布局，并生成高质量的 PDF 文档。

3.1.2 使用场景

EO.Pdf 在需要将动态生成的 HTML 内容转换为 PDF 格式的情况下非常有用。例如，将网页内容转换为可供用户下载或打印的 PDF 文件。

3.2 安装与配置

3.2.1 安装指南

首先，可以通过 NuGet 包管理器来安装 EO.Pdf。在 Visual Studio 中，打开项目并右键点击“引用” -> “管理 NuGet 程序包”，然后搜索并安装 EO.Pdf。

另外，也可以从官方网站 EO.Pdf 官网下载 EO.Pdf，并手动添加到项目引用中。

3.2.2 初始配置

安装完成后，在项目中引入 EO 命名空间即可开始使用 EO.Pdf。

using EO.Pdf;

3.3 API 概览

3.3.1 HTML转PDF

以下是一个简单的示例，演示如何使用 EO.Pdf 将 HTML 内容转换为 PDF 格式：

string htmlContent = "<html><body><h1>Hello, World!</h1></body></html>";
PdfDocument pdfDoc = new PdfDocument();
pdfDoc.HtmlToPdf(htmlContent, "output.pdf");

以上代码创建了一个包含简单 HTML 内容的字符串，并使用 EO.Pdf 将其转换为 PDF 文件。

3.3.2 自定义样式

EO.Pdf 允许开发人员通过 CSS 来自定义 PDF 文件的样式。以下是一个示例，演示如何使用自定义样式将 HTML 内容转换为具有自定义样式的 PDF 文件：

string htmlContent = "<html><head><style>h1 { color: blue; }</style></head><body><h1>Hello, World!</h1></body></html>";
PdfDocument pdfDoc = new PdfDocument();
pdfDoc.HtmlToPdf(htmlContent, "styled_output.pdf");

以上代码中，通过内联样式将标题设置为蓝色，并将其转换为 PDF 文件。

通过这些示例，开发人员可以了解如何使用 EO.Pdf 将 HTML 内容转换为 PDF 格式，并且能够根据需要定制输出的样式。

EO.Pdf 官方网站提供了更多详细的文档和示例，可以帮助开发人员更好地理解和使用该库。

4. Apache PDFBox：C#中处理PDF文件的库

Apache PDFBox是一个用于处理PDF文件的开源Java库，但通过IKVM.NET，我们可以在C#中使用它。本文将介绍如何在C#中使用Apache PDFBox来处理PDF文件。

4.1 简介

Apache PDFBox提供了丰富的功能，包括创建新的PDF文档、解析和提取现有文档的内容以及对文档进行操作。

4.1.1 核心功能

创建新的PDF文档
解析和提取现有文档的内容
对文档进行操作（例如合并、分割、加密）

4.1.2 使用场景

Apache PDFBox适用于需要对PDF文件进行各种操作的应用程序，比如生成报告、提取文本内容、加密和解密等。

4.2 安装与配置

要在C#项目中使用Apache PDFBox，首先需要安装相应的NuGet包，并进行一些初始设置。

4.2.1 安装指导

通过NuGet包管理器或Visual Studio控制台可使用以下命令安装Apache PDFBox：

Install-Package IKVM -Version 8.1.5717
Install-Package PDFBox -Version 2.0.24

这将安装所需的IKVM.NET和PDFBox库。

4.2.2 初始设置

在使用PDFBox之前，需要将Java环境整合到C#项目中。请确保已正确配置IKVM.NET，使其能够将Java代码编译为.NET可执行代码。

4.3 API 概览

PDFBox提供了丰富的API，以下将介绍其中两个常见的功能。

4.3.1 PDF内容提取

PDFBox可以用来提取PDF文档中的文本内容，以下是一个简单的示例代码：

using org.apache.pdfbox.pdmodel;
using org.apache.pdfbox.text;PDDocument doc = PDDocument.load("example.pdf");
PDFTextStripper stripper = new PDFTextStripper();
string text = stripper.getText(doc);
doc.close();
Console.WriteLine(text);

通过上述代码，我们可以提取名为"example.pdf"的PDF文档中的文本内容。更多关于PDF内容提取的详细信息请参考PDFBox文档。

4.3.2 文档操作

PDFBox还可以对PDF文档进行各种操作，比如合并不同的PDF文档、分割PDF文档等。以下是一个简单的示例代码：

using org.apache.pdfbox.multipdf;PDDocument doc1 = PDDocument.load("document1.pdf");
PDDocument doc2 = PDDocument.load("document2.pdf");PDFMergerUtility merger = new PDFMergerUtility();
merger.appendDocument(doc1, doc2);
merger.save("merged_document.pdf");doc1.close();
doc2.close();

通过上述代码，我们可以将名为"document1.pdf"和"document2.pdf"的两个PDF文档合并成一个新的文档"merged_document.pdf"。更多关于文档操作的详细信息请参考PDFBox文档。

5. MigraDoc：用于创建PDF和RTF文档的C#库

MigraDoc 是一个用于创建 PDF 和 RTF 文档的 C# 库，提供了丰富的功能和灵活的 API，使得在 .NET 平台上生成文档变得简单而灵活。

5.1 简介

MigraDoc 提供了一系列强大的功能，包括但不限于：

5.1.1 核心功能

创建 PDF 和 RTF 文档
添加文字、表格、图像等元素到文档中
设置页面布局和格式
支持丰富的样式定义

5.1.2 使用场景

MigraDoc 可以应用于各种场景，比如：

动态生成报告
打印或导出数据
构建可定制化的文档

5.2 安装与配置

5.2.1 安装指引

可以通过 NuGet 来安装 MigraDoc。在 Visual Studio 中打开 NuGet 包管理器控制台，并运行以下命令来安装 MigraDoc：

Install-Package MigraDoc

5.2.2 基本配置

安装完成后，在代码中引入 MigraDoc 的命名空间：

using MigraDoc.DocumentObjectModel;
using MigraDoc.Rendering;

5.3 API 概览

5.3.1 文档结构设计

MigraDoc 的文档结构主要由 Document、Section、Paragraph、Table 等对象组成。以下是一个简单的示例，演示如何创建一个包含标题和段落的文档：

Document document = new Document();
Section section = document.AddSection();
Paragraph paragraph = section.AddParagraph("Hello, World!");

更多关于文档结构设计的详细信息，请参考官方文档：MigraDoc 文档结构设计

5.3.2 样式定义

MigraDoc 允许用户定义各种样式，包括文字样式、段落样式、表格样式等。下面是一个简单的示例，展示了如何定义并应用一个基本的文本样式：

Document document = new Document();
Section section = document.AddSection();
Paragraph paragraph = section.AddParagraph("This is a sample text.");// 定义样式
Style style = document.Styles.AddStyle("MyStyle", "Normal");
style.Font.Size = 12;
style.Font.Color = Colors.DarkGray;// 应用样式
paragraph.Style = "MyStyle";

更多关于样式定义的详细信息，请参考官方文档：MigraDoc 样式定义

6. Spire.PDF：C#中处理PDF文件的全功能库

Spire.PDF 是一款功能强大的 C# PDF 处理库，提供丰富的 API 接口，方便用户对 PDF 文件进行编辑、加密和解密等操作。

6.1 简介

6.1.1 核心功能

Spire.PDF 提供了丰富的功能，包括但不限于：

创建 PDF 文档
加载、浏览和打印 PDF 文档
编辑、插入、删除页面内容
添加水印、书签、标签
合并、拆分、压缩 PDF 文件
加密、解密 PDF 文档
PDF 转图片、HTML、XPS

6.1.2 使用场景

Spire.PDF 可以广泛应用于企业文档管理系统、办公自动化系统、报表分发系统等领域。在需要对 PDF 文件进行编辑、转换、安全保护等场景下都能发挥作用。

6.2 安装与配置

6.2.1 安装方法

用户可以通过 NuGet 包管理器来安装 Spire.PDF。在 Visual Studio 中打开 NuGet 包管理器控制台，执行以下命令进行安装：

Install-Package Spire.PDF

6.2.2 基本设置

使用 Spire.PDF 库之前，需要在项目中引用该库，并在代码中添加命名空间：

using Spire.Pdf;

6.3 API 概览

6.3.1 PDF编辑

Spire.PDF 提供了丰富的 PDF 编辑功能，以下是一个简单的示例，演示如何创建一个 PDF 文档并添加文本：

PdfDocument pdf = new PdfDocument();
PdfPageBase page = pdf.Pages.Add();PdfFont font = new PdfFont(PdfFontFamily.Helvetica, 11);
PdfBrush brush = PdfBrushes.Black;page.Canvas.DrawString("Hello, Spire.PDF!", font, brush, new PointF(10, 10));pdf.SaveToFile("output.pdf");
pdf.Close();

以上代码创建了一个包含 “Hello, Spire.PDF!” 文本的 PDF 文档，并将其保存到 output.pdf 文件中。更多关于 PDF 编辑的 API 信息，可参考官方文档。

6.3.2 加密解密

Spire.PDF 还支持 PDF 文件的加密和解密操作。下面是一个示例演示如何对 PDF 文件进行密码保护：

PdfDocument pdf = new PdfDocument();
pdf.LoadFromFile("input.pdf");pdf.Security.KeySize = PdfEncryptionKeySize.Key256Bit;
pdf.Security.OwnerPassword = "ownerPwd";
pdf.Security.Permissions = PdfPermissionsFlags.Default;pdf.SaveToFile("output.pdf");
pdf.Close();

在上述代码中，我们加载了一个已存在的 PDF 文件，并设置了 256 位密钥进行加密保护，并指定了 ownerPwd 为所有者密码。更多关于 PDF 加密解密的 API 信息，可参考官方文档。

总结

通过本文的介绍，读者可以对C#中常用的PDF生成库有一个全面的了解。不同的库适用于不同的场景和需求，比如iTextSharp适合进行PDF文档的创建和设计，而EO.Pdf则更适合将HTML转换为PDF。PdfSharp、Apache PDFBox、MigraDoc和Spire.PDF也各有其独特的功能和优势。因此，在实际项目中，开发人员可以根据自身的需求和特定情况选择最合适的库来完成PDF文件的生成和处理工作。