如何添加目录

This article was translated from English: Does it need improvement?
Translated
View the article in English

查克尼特·宾

目录 (技术选择委员会) 就像是帮助读者浏览 PDF 文档内容的路线图。它通常出现在开头,列出 PDF 的主要部分或章节,以及每个部分开始的页码。这样,读者就能快速找到并跳转到文档的特定部分,从而更轻松地获取所需的信息。

IronPDF 提供了创建目录的功能,目录中的超链接指向 "h1"、"h2"、"h3"、"h4"、"h5 "和 "h6 "元素。该目录的默认样式不会与 HTML 内容中的其他样式冲突。


适用于PDF的C# NuGet库

安装使用 NuGet

Install-Package IronPdf
Java PDF JAR

下载 DLL

下载DLL

手动安装到你的项目中

适用于PDF的C# NuGet库

安装使用 NuGet

Install-Package IronPdf
Java PDF JAR

下载 DLL

下载DLL

手动安装到你的项目中

开始在您的项目中使用IronPDF,并立即获取免费试用。

第一步:
green arrow pointer

查看 IronPDFNuget 用于快速安装和部署。它有超过800万次下载,正在使用C#改变PDF。

适用于PDF的C# NuGet库 nuget.org/packages/IronPdf/
Install-Package IronPdf

考虑安装 IronPDF DLL 直接。下载并手动安装到您的项目或GAC表单中: IronPdf.zip

手动安装到你的项目中

下载DLL

添加目录示例

使用 TableOfContents 属性可在输出 PDF 文档中创建目录。该属性可分配给三种TableOfContentsType之一,具体描述如下:

  • 无:不创建目录
  • 基本:创建不带页码的目录

  • WithPageNumbers:创建有页码的目录

要更好地了解这一功能,可下载下面的 HTML 示例文件:

代码

:path=/static-assets/pdf/content-code-examples/how-to/table-of-contents.cs
using IronPdf;
using System.IO;

// Instantiate Renderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

// Configure render options
renderer.RenderingOptions = new ChromePdfRenderOptions
{
    // Enable table of content feature
    TableOfContents = TableOfContentsTypes.WithPageNumbers,
};

PdfDocument pdf = renderer.RenderHtmlFileAsPdf("tableOfContent.html");

pdf.SaveAs("tableOfContents.pdf");
Imports IronPdf
Imports System.IO

' Instantiate Renderer
Private renderer As New ChromePdfRenderer()

' Configure render options
renderer.RenderingOptions = New ChromePdfRenderOptions With {.TableOfContents = TableOfContentsTypes.WithPageNumbers}

Dim pdf As PdfDocument = renderer.RenderHtmlFileAsPdf("tableOfContent.html")

pdf.SaveAs("tableOfContents.pdf")
VB   C#

输出 PDF

目录将包含到每个 'h1'、'h2'、'h3'、'h4'、'h5' 和 'h6' 的超链接。

请注意
在文档上使用 Merge 方法会破坏目录的超链接。


PDF 上的目录位置

1.确保 HTML 文档有正确的页眉标记 (h1 至 h6).

  1. 可选择在您希望目录出现的位置插入一个 div。如果没有提供下面的 div,IronPDF 将在开头插入目录。
    <div id="ironpdf-toc"></div>
    <div id="ironpdf-toc"></div>
HTML
  1. 在渲染选项中选择渲染有页码或无页码的目录。

目录的样式

可以使用 CSS 来设置目录的样式,方法是使用定义目录样式的各种 CSS 选择器。

此外,还可以使用 CustomCssUrl 属性修改样式。让我们先下载一个 CSS 文件,其中包含下面目录的原始样式。

在继续之前
目前,不建议在设置目录样式时覆盖 page-break-before 和 page-break-after 属性,因为这会破坏页码计算。目前的实现方式希望目录与其他文档内容分页。

:path=/static-assets/pdf/content-code-examples/how-to/table-of-contents-overwrite-styling.cs
using IronPdf;
using System.IO;

// Instantiate Renderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

// Configure render options
renderer.RenderingOptions = new ChromePdfRenderOptions
{
    // Enable table of content feature
    TableOfContents = TableOfContentsTypes.WithPageNumbers,
    CustomCssUrl = "./custom.css"
};

// Read HTML text from file
string html = File.ReadAllText("tableOfContent.html");
PdfDocument pdf = renderer.RenderHtmlAsPdf(html);

pdf.SaveAs("tableOfContents.pdf");
Imports IronPdf
Imports System.IO

' Instantiate Renderer
Private renderer As New ChromePdfRenderer()

' Configure render options
renderer.RenderingOptions = New ChromePdfRenderOptions With {
	.TableOfContents = TableOfContentsTypes.WithPageNumbers,
	.CustomCssUrl = "./custom.css"
}

' Read HTML text from file
Dim html As String = File.ReadAllText("tableOfContent.html")
Dim pdf As PdfDocument = renderer.RenderHtmlAsPdf(html)

pdf.SaveAs("tableOfContents.pdf")
VB   C#

样式标题

使用 'ironpdf-toc ul li.h1' 选择器为目录中的 H1 标题应用不同的样式。将 'h1' 替换为 'h2' 到 'h6' 可以更改每个相应标题的样式。

#ironpdf-toc ul li.h1 {
    font-style: italic;
    font-weight: bold;
}
样式标题

字体家族

使用 "#ironpdf-toc li .title "和 "#ironpdf-toc li .page "选择器,可以覆盖目录的字体家族。让我们为标题使用 "草书 "字体,并利用 @font-face 属性使用自定义的".page "字体。柠檬字体由 Eduardo Tunni 设计。

#ironpdf-toc li .title {
    order: 1;
    font-family: cursive;
}

@font-face {
    font-family: 'lemon';
    src: url('Lemon-Regular.ttf')
}

#ironpdf-toc li .page {
    order: 3;
    font-family: 'lemon', sans-serif;
}
设置自定义字体系列

缩进

缩进可以使用":root "选择器来控制。该值决定了每一级标题的缩进量 (h1, h2, ...) 在目录中。可以根据需要增加缩进量,也可以不缩进(值为 0)。

:root {
    --indent-length: 25px;
}
设置自定义缩进

点线

删除页眉标题和页码之间的虚线。在原始样式中,第二个参数是 "currentcolor 1px"。将其更改为 "transparent 1px",以删除这些点。指定其他属性也很重要,因为在这个选择器中,新的样式将完全覆盖旧的样式,而不仅仅是添加到旧的样式中。

#ironpdf-toc li::after {
    background-image: radial-gradient(circle, transparent 1px, transparent 1.5px);
    background-position: bottom;
    background-size: 1ex 4.5px;
    background-repeat: space no-repeat;
    content: "";
    flex-grow: 1;
    height: 1em;
    order: 2;
}
删除圆点

查克尼特·宾

软件工程师

Chaknith 是开发者中的福尔摩斯。他第一次意识到自己可能在软件工程方面有前途,是在他出于乐趣做代码挑战的时候。他的重点是 IronXL 和 IronBarcode,但他为能帮助客户解决每一款产品的问题而感到自豪。Chaknith 利用他从直接与客户交谈中获得的知识,帮助进一步改进产品。他的轶事反馈不仅仅局限于 Jira 票据,还支持产品开发、文档编写和市场营销,从而提升客户的整体体验。当他不在办公室时,他可能会在学习机器学习、编程或徒步旅行。