平时做技术实践时,很多问题不是概念不会,而是细节没串起来。拿“C#代码实现方法读取并导出PDF书签”来说,它看着像小点,放到项目里常会牵出环境、配置、兼容性和维护成本。下面按实际采用顺序,把思路、关键写法和容易踩坑的地方讲清楚,便于大家直接对照操作。
在这个场景下,PDF 书签(大纲)是文档导航的核心要素,尤其对于长文档或技术手册,提取书签信息可用来生成目录、索引或进行文档结构分析。下面会介绍如何采用 Free Spire.PDF for .NET 库,借助 C# 代码完整读取 PDF 文件中的所有书签(包括多级嵌套书签),同时将标题、显示样式等信息导出到文本文件。
1. 环境准备
1.1 安装免费库
在 Visual Studio 中借助 NuGet 包管理器安装 Free Spire.PDF:
Install-Package FreeSpire.PDF
实际处理时,该免费版本兼容读取 PDF 书签等基础操作,无需额外授权文件,但有单文件10页的页数限制。
1.2 引用命名空间
代码中需引入以下命名空间:
using System;
using System.IO;
using System.Text;
using Spire.Pdf;
using Spire.Pdf.Bookmarks;
2. 核心实现逻辑
整体流程分为四步:
- 加载目标 PDF 文档。
- 拿到文档的
PdfBookmarkCollection书签集合。 - 递归遍历每个书签及其子书签,提取标题和显示样式。
- 将提取的内容写入文本文件。
2.1 加载文档并拿到书签集合
PdfDocument pdf = new PdfDocument();
pdf.LoadFromFile(@"D:test.pdf");
PdfBookmarkCollection bookmarks = pdf.Bookmarks;
Bookmarks 属性得到一个集合,包含顶层书签。如果文档没有书签,Count 为 0。
2.2 递归遍历书签树
理解这一步时,书签结构是典型的树形结构:每个书签节点可能拥有子书签集合(借助 Count 属性和索引器访问)。我们设计两个方法:
GetBookmarks:处理顶层书签,新建StringBuilder同时启动递归。GetChildBookmark:递归处理子书签。
public static void GetBookmarks(PdfBookmarkCollection bookmarks, string result)
{
StringBuilder content = new StringBuilder();
if (bookmarks.Count > 0)
{
content.AppendLine("Pdf bookmarks:");
foreach (PdfBookmark parentBookmark in bookmarks)
{
// 获取标题
content.AppendLine(parentBookmark.Title);
// 获取显示样式(如普通、粗体、斜体等)
content.AppendLine(parentBookmark.DisplayStyle.ToString());
// 递归处理子书签
GetChildBookmark(parentBookmark, content);
}
}
File.WriteAllText(result, content.ToString());
}
递归方法:
public static void GetChildBookmark(PdfBookmark parentBookmark, StringBuilder content)
{
if (parentBookmark.Count > 0)
{
foreach (PdfBookmark childBookmark in parentBookmark)
{
content.AppendLine(childBookmark.Title);
content.AppendLine(childBookmark.DisplayStyle.ToString());
GetChildBookmark(childBookmark, content);
}
}
}
2.3 完整示例代码
理解这一步时,以下是一个控制台应用程序的完整实现,将书签信息输出到 GetPdfBookmarks.txt 文件。
using System;
using System.IO;
using System.Text;
using Spire.Pdf;
using Spire.Pdf.Bookmarks;
namespace GetBookmark
{
internal class Program
{
static void Main(string[] args)
{
PdfDocument pdf = new PdfDocument();
pdf.LoadFromFile(@"D:testptest.pdf");
PdfBookmarkCollection bookmarks = pdf.Bookmarks;
string result = "GetPdfBookmarks.txt";
GetBookmarks(bookmarks, result);
Console.WriteLine("书签提取完成,结果已保存至:" + result);
}
public static void GetBookmarks(PdfBookmarkCollection bookmarks, string result)
{
StringBuilder content = new StringBuilder();
if (bookmarks.Count > 0)
{
content.AppendLine("Pdf bookmarks:");
foreach (PdfBookmark parentBookmark in bookmarks)
{
content.AppendLine(parentBookmark.Title);
content.AppendLine(parentBookmark.DisplayStyle.ToString());
GetChildBookmark(parentBookmark, content);
}
}
else
{
content.AppendLine("该 PDF 文档不包含任何书签。");
}
File.WriteAllText(result, content.ToString());
}
public static void GetChildBookmark(PdfBookmark parentBookmark, StringBuilder content)
{
if (parentBookmark.Count > 0)
{
foreach (PdfBookmark childBookmark in parentBookmark)
{
content.AppendLine(childBookmark.Title);
content.AppendLine(childBookmark.DisplayStyle.ToString());
GetChildBookmark(childBookmark, content);
}
}
}
}
}
3. 输出格式说明
理解这一步时,生成的文本文件每两行代表一个书签:第一行是标题,第二行是显示样式。比如:
Pdf bookmarks:
第1章 简介
Regular
1.1 背景
Bold
1.2 目标
Italic
第2章 实现
Regular
2.1 环境搭建
Regular
DisplayStyle 是一个枚举,可能的值包括:
Regular:普通文本Bold:粗体Italic:斜体
根据 PDF 文件的实际书签样式,输出结果会相应变化。
4. 注意事项与扩展
4.1 书签可能为空
若 PDF 没有书签,bookmarks.Count 为 0,代码会写入提示信息,避免空文件。
4.2 目标页码与动作的拿到
在这个场景下,上述示例仅拿到了标题和样式。如果需拿到书签跳转的目标页码,能够采用 PdfBookmark.Action 属性(需判断动作类型)。比如:
if (parentBookmark.Action is PdfGoToAction goToAction)
{
int pageIndex = pdf.Pages.IndexOf(goToAction.Destination.Page);
content.AppendLine($"跳转至第 {pageIndex + 1} 页");
}
落到代码里,由于 Free Spire.PDF 对 Action 的兼容较为完整,可根据实际需求扩展。
4.3 性能考虑
结合项目来看,对于包含数千个书签的 PDF,递归遍历不会有明显性能问题。但若需频繁提取,可考虑将 StringBuilder 替换为 StreamWriter 流式写入,降低内存占用。
4.4 编码处理
File.WriteAllText 默认采用 UTF-8 编码,如需指定编码(如 GB2312),可改用 StreamWriter。
5. 总结
在这个场景下,本文演示了如何借助免费 .NET 库完整提取 PDF 文档的多级书签信息。关键技术点包括:
- 借助
PdfDocument.Bookmarks拿到根书签集合。 - 递归遍历
PdfBookmark节点的Count和索引器。 - 读取
Title和DisplayStyle属性。 - 将结构化数据写入文本文件。
落到代码里,这种方法不依赖 Adobe Acrobat 或其他 GUI 工具,很适合集成到后台服务或文档处理管道中。开发者能够根据上述模式进一步扩展,拿到书签的页码、缩放方式甚至修改书签结构。
到此这篇关于C#代码实现读取同时导出PDF书签 的文章就介绍到这了,更多相关C#读取并导出PDF书签 内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多兼容脚本之家!
- C#采用iTextSharp拿到PDF文件书签信息的操作方法
- C# 添加、修改和删除PDF书签的实例代码
- C#采用Spire.PDF for .NET轻松提取PDF文件中的文字内容
- C#采用Spire.PDF for .NET实现将PDF转换为PCL格式
- C#借助Free Spire.PDF for .NET实现轻松提取PDF文本
- C#采用Spire.PDF for .NET实现设置或修改PDF页面尺寸
- C#借助Spire.PDF for .NET实现将PDF转换为SVG
- C#采用Spire.PDF for .NET实现为PDF添加X/Y页码