如何添加页眉和页脚

Translated

View the article in English

由乔尔迪·巴尔迪亚

需要在 PDF 文档的每页顶部或底部加入页码、公司徽标或日期吗？有了页眉和页脚，您可以! 有了 IronPDF，在 C# 项目中为 PDF 应用页眉和页脚就变得非常简单。

如何添加页眉和页脚

下载 C# 库以添加页眉和页脚
加载现有 PDF 或渲染新 PDF
使用 添加文本头 和 添加文本页脚 methods to add text headers 和 footers
使用 AddHtmlHeaders 和 添加 HtmlFooters methods to add HTML headers 和 footers
Add headers 和 footers at rendering time by configuring the rendering options

或

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

第一步：

免费开始

添加文本页眉/页脚示例

要创建仅包含文本的页眉/页脚，请实例化一个 TextHeaderFooter 对象，添加所需的文本，然后将该对象添加到 PDF 中。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-add-textheaderfooter.cs

using IronPdf;

// Instantiate renderer and create PDF
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

// Create text header
TextHeaderFooter textHeader = new TextHeaderFooter
{
    CenterText = "This is the header!",
};

// Create text footer
TextHeaderFooter textFooter = new TextHeaderFooter
{
    CenterText = "This is the footer!",
};

// Add text header and footer to the PDF
pdf.AddTextHeaders(textHeader);
pdf.AddTextFooters(textFooter);

pdf.SaveAs("addTextHeaderFooter.pdf");

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

或者，也可以使用呈现器的呈现选项直接添加页眉/页脚。这将在渲染过程中添加文本页眉和页脚。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-render-with-textheaderfooter.cs

using IronPdf;

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

// Create header and add to rendering options
renderer.RenderingOptions.TextHeader = new TextHeaderFooter
{
    CenterText = "This is the header!",
};


// Create footer and add to rendering options
renderer.RenderingOptions.TextFooter = new TextHeaderFooter
{
    CenterText = "This is the footer!",
};

// Render PDF with header and footer
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");
pdf.SaveAs("renderWithTextHeaderFooter.pdf");

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

自定义文本和分隔线属性

在TextHeaderFooter类中，您可以设置左侧、中间和右侧位置的文本。此外，您还可以自定义文本的字体类型和大小，并通过配置相关属性添加自定义颜色的分隔线。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-textheaderfooter-options.cs

using IronPdf;
using IronPdf.Font;
using IronSoftware.Drawing;

// Create text header
TextHeaderFooter textHeader = new TextHeaderFooter
{
    CenterText = "Center text", // Set the text in the center
    LeftText = "Left text", // Set left-hand side text
    RightText = "Right text", // Set right-hand side text
    Font = IronSoftware.Drawing.FontTypes.ArialBoldItalic, // Set font
    FontSize = 16, // Set font size
    DrawDividerLine = true, // Draw Divider Line
    DrawDividerLineColor = Color.Red, // Set color of divider line
};

Imports IronPdf
Imports IronPdf.Font
Imports IronSoftware.Drawing

' Create text header
Private textHeader As New TextHeaderFooter With {
	.CenterText = "Center text",
	.LeftText = "Left text",
	.RightText = "Right text",
	.Font = IronSoftware.Drawing.FontTypes.ArialBoldItalic,
	.FontSize = 16,
	.DrawDividerLine = True,
	.DrawDividerLineColor = Color.Red
}

VB C#

输出文本标题

您可以在 API文档.

为文本页眉/页脚设置页边距

默认情况下，IronPDF 的文本页眉和页脚带有预定义的页边距。如果您想让文本页眉横跨 PDF 文档的整个宽度，可以指定页边距值为 0。这可以通过在 "AddTextHeaders "和 "AddTextFooters "函数中直接设置页边距或通过ChromePdfRenderer中的RenderingOptions来实现。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-textheaderfooter-margins.cs

using IronPdf;

// Instantiate renderer and create PDF
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

TextHeaderFooter header = new TextHeaderFooter
{
    CenterText = "This is the header!",
};

TextHeaderFooter footer = new TextHeaderFooter
{
    CenterText = "This is the footer!",
};

pdf.AddTextHeaders(header, 35, 30, 25); // Left Margin = 35, Right Margin  = 30, Top Margin = 25
pdf.AddTextFooters(footer, 35, 30, 25); // Margin values are in mm

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

如果在 ChromePdfRenderer 的 RenderingOptions 中添加页边距值，这些页边距也将应用于页眉和页脚。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-rendering-options-margins.cs

using IronPdf;

// Instantiate renderer and create PDF
ChromePdfRenderer renderer = new ChromePdfRenderer();

TextHeaderFooter header = new TextHeaderFooter
{
    CenterText = "This is the header!",
};

TextHeaderFooter footer = new TextHeaderFooter
{
    CenterText = "This is the footer!",
};

// Margin values are in mm
renderer.RenderingOptions.MarginRight = 30;
renderer.RenderingOptions.MarginLeft = 30;
renderer.RenderingOptions.MarginTop = 25;
renderer.RenderingOptions.MarginBottom = 25;
renderer.RenderingOptions.UseMarginsOnHeaderAndFooter = UseMargins.All;

// Add header and footer to renderer
renderer.RenderingOptions.TextHeader = header;
renderer.RenderingOptions.TextFooter = footer;

PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

IRON VB CONVERTER ERROR developers@ironsoftware.com

VB C#

动态保证金规模

当不同文档的页眉内容不同时，静态页边距就会产生问题。不仅需要调整页眉和页脚的边距，还需要调整主 HTML 边距，以适应不同的页眉和页脚大小。因此，我们实施了动态页边距大小功能，页眉和页脚的高度将根据内容进行动态调整，而主 HTML 将相应地重新定位。请使用下面的代码查看该功能：

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-dynamic-marigns.cs

using IronPdf;

ChromePdfRenderer renderer = new ChromePdfRenderer();

renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter()
{
    HtmlFragment = @"<div style='background-color: #4285f4; color: white; padding: 15px; text-align: center;'>
                    <h1>Example header</h1> <br>
                    <p>Header content</p>
                    </div>",
    // Enable the dynamic height feature
    MaxHeight = HtmlHeaderFooter.FragmentHeight,
};

PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Main HTML content</h1>");
pdf.SaveAs("dynamicHeaderSize.pdf");

Imports IronPdf

Private renderer As New ChromePdfRenderer()

renderer.RenderingOptions.HtmlHeader = New HtmlHeaderFooter() With {
	.HtmlFragment = "<div style='background-color: #4285f4; color: white; padding: 15px; text-align: center;'>
                    <h1>Example header</h1> <br>
                    <p>Header content</p>
                    </div>",
	.MaxHeight = HtmlHeaderFooter.FragmentHeight
}

Dim pdf As PdfDocument = renderer.RenderHtmlAsPdf("<h1>Main HTML content</h1>")
pdf.SaveAs("dynamicHeaderSize.pdf")

VB C#

元数据到文本页眉/页脚

通过在文本中加入占位符字符串，你可以轻松添加 PDF 的页码、日期和标题等元数据。以下是所有可用的元数据选项：

{页码}:当前页码。
{总页数}:总页数。
{网址}:渲染 PDF 文档的 Web URL。
{日期}:当前日期。
{时间}:当前时间
{html-title}:在 HTML 的 title 标签中指定的 HTML 标题。
{pdf标题}:PDF 元数据中指定的 PDF 标题。

了解更多 {页码} 和 {总页数}请访问添加页码指南。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-mail-merge.cs

using IronPdf;

// Create header and footer
TextHeaderFooter textHeader = new TextHeaderFooter
{
    CenterText = "{page} of {total-pages}",
    LeftText = "Today's date: {date}",
    RightText = "The time: {time}",
};

TextHeaderFooter textFooter = new TextHeaderFooter
{
    CenterText = "Current URL: {url}",
    LeftText = "Title of the HTML: {html-title}",
    RightText = "Title of the PDF: {pdf-title}",
};

Imports IronPdf

' Create header and footer
Private textHeader As New TextHeaderFooter With {
	.CenterText = "{page} of {total-pages}",
	.LeftText = "Today's date: {date}",
	.RightText = "The time: {time}"
}

Private textFooter As New TextHeaderFooter With {
	.CenterText = "Current URL: {url}",
	.LeftText = "Title of the HTML: {html-title}",
	.RightText = "Title of the PDF: {pdf-title}"
}

VB C#

添加 HTML 页眉/页脚示例

您可以使用 HTML 和 CSS 进一步自定义页眉/页脚。要创建 HTML 页眉/页脚，请使用 HtmlHeaderFooter 类。如果想保留 CSS 样式表中的 CSS 样式，请确保在类属性中设置 LoadStylesAndCSSFromMainHtmlDocument = true。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-htmlheaderfooter.cs

using IronPdf;

string headerHtml = @"
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a header!</h1>
    </body>
    </html>";

string footerHtml = @"
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a footer!</h1>
    </body>
    </html>";

// Instantiate renderer and create PDF
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

// Create header and footer
HtmlHeaderFooter htmlHeader = new HtmlHeaderFooter
{
    HtmlFragment = headerHtml,
    LoadStylesAndCSSFromMainHtmlDocument = true,
};

HtmlHeaderFooter htmlFooter = new HtmlHeaderFooter
{
    HtmlFragment = footerHtml,
    LoadStylesAndCSSFromMainHtmlDocument = true,
};

// Add to PDF
pdf.AddHtmlHeaders(htmlHeader);
pdf.AddHtmlFooters(htmlFooter);

Imports IronPdf

Private headerHtml As String = "
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a header!</h1>
    </body>
    </html>"

Private footerHtml As String = "
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a footer!</h1>
    </body>
    </html>"

' Instantiate renderer and create PDF
Private renderer As New ChromePdfRenderer()
Private pdf As PdfDocument = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>")

' Create header and footer
Private htmlHeader As New HtmlHeaderFooter With {
	.HtmlFragment = headerHtml,
	.LoadStylesAndCSSFromMainHtmlDocument = True
}

Private htmlFooter As New HtmlHeaderFooter With {
	.HtmlFragment = footerHtml,
	.LoadStylesAndCSSFromMainHtmlDocument = True
}

' Add to PDF
pdf.AddHtmlHeaders(htmlHeader)
pdf.AddHtmlFooters(htmlFooter)

VB C#

与文本页眉和页脚类似，上面显示的 AddHtmlHeaders 和 AddHtmlFooters 方法也应用了预定义的页边距。要应用自定义边距，请使用函数的重载，并指定边距值。要跨整个内容而不使用任何边距，可将重载函数中的边距设置为 0。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-htmlheaderfooter-margins.cs

// Add to PDF
pdf.AddHtmlHeaders(header, 0, 0, 0);
pdf.AddHtmlFooters(footer, 0, 0, 0);

' Add to PDF
pdf.AddHtmlHeaders(header, 0, 0, 0)
pdf.AddHtmlFooters(footer, 0, 0, 0)

VB C#

也可以直接通过呈现器的呈现选项添加页眉和页脚。这将在呈现过程中添加 HTML 页眉和页脚。

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-render-with-htmlheaderfooter.cs

using IronPdf;

string headerHtml = @"
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a header!</h1>
    </body>
    </html>";

string footerHtml = @"
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a footer!</h1>
    </body>
    </html>";

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

// Create header and footer and add to rendering options
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter
{
    HtmlFragment = headerHtml,
    LoadStylesAndCSSFromMainHtmlDocument = true,
};

renderer.RenderingOptions.HtmlFooter = new HtmlHeaderFooter
{
    HtmlFragment = footerHtml,
    LoadStylesAndCSSFromMainHtmlDocument = true,
};

// Render PDF with header and footer
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

Imports IronPdf

Private headerHtml As String = "
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a header!</h1>
    </body>
    </html>"

Private footerHtml As String = "
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a footer!</h1>
    </body>
    </html>"

' Instantiate renderer
Private renderer As New ChromePdfRenderer()

' Create header and footer and add to rendering options
renderer.RenderingOptions.HtmlHeader = New HtmlHeaderFooter With {
	.HtmlFragment = headerHtml,
	.LoadStylesAndCSSFromMainHtmlDocument = True
}

renderer.RenderingOptions.HtmlFooter = New HtmlHeaderFooter With {
	.HtmlFragment = footerHtml,
	.LoadStylesAndCSSFromMainHtmlDocument = True
}

' Render PDF with header and footer
Dim pdf As PdfDocument = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>")

VB C#

在文本和 HTML 页眉/页脚之间做出选择

在决定使用文本还是 HTML 页眉/页脚时，要考虑权衡利弊。如果你优先考虑加快 PDF 的渲染速度，那就选择文本页眉/页脚。另一方面，如果可定制性和样式至关重要，则应选择 HTML 页眉/页脚。当 HTML 页眉/页脚不包含太多内容时，文本页眉/页脚和 HTML 页眉/页脚的渲染时间差不会太大。不过，随着 HTML 页眉/页脚中资产大小和数量的增加，渲染时间也会增加。

乔尔迪·巴尔迪亚

软件工程师

Jordi 最擅长 Python、C# 和 C++，当他不在 Iron Software 运用技能时，他会进行游戏编程。作为产品测试、产品开发和研究的负责人之一，Jordi 为持续的产品改进增添了极大的价值。多样化的经验让他充满挑战和参与感，他说这是他在 Iron Software 工作中最喜欢的方面之一。Jordi 在佛罗里达州迈阿密长大，并在佛罗里达大学学习计算机科学和统计学。

准备开始了吗？版本： 2024.9 刚刚发布

查看许可证 >

如何添加页眉和页脚

如何添加页眉和页脚

添加文本页眉/页脚示例

自定义文本和分隔线属性

输出文本标题

为文本页眉/页脚设置页边距

动态保证金规模

元数据到文本页眉/页脚

添加 HTML 页眉/页脚示例

在文本和 HTML 页眉/页脚之间做出选择

乔尔迪·巴尔迪亚

软件工程师

准备开始了吗？版本： 2024.9 刚刚发布

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 30天试用密钥立即。

试用表格已提交
成功地.

受到全球数百万工程师的信任

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 30天试用密钥立即。

受到全球数百万工程师的信任

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 30天试用密钥立即。

试用表格已提交
成功地.

受到全球数百万工程师的信任

IronPDF 是 IRON 的一部分套装

如何添加页眉和页脚

如何添加页眉和页脚

安装使用 NuGet

下载 DLL

手动安装到你的项目中

安装使用 NuGet

下载 DLL

手动安装到你的项目中

添加文本页眉/页脚示例

自定义文本和分隔线属性

输出文本标题

为文本页眉/页脚设置页边距

动态保证金规模

元数据到文本页眉/页脚

添加 HTML 页眉/页脚示例

在文本和 HTML 页眉/页脚之间做出选择

乔尔迪·巴尔迪亚

软件工程师

准备开始了吗？ 版本： 2024.9 刚刚发布

获取您的免费

试用表格已提交成功地.

试用表格已提交成功地.

试用表格已提交成功地.

试用表格已提交成功地.

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 30天试用密钥 立即。

试用表格已提交成功地.

受到全球数百万工程师的信任

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 30天试用密钥 立即。

受到全球数百万工程师的信任

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 30天试用密钥 立即。

试用表格已提交成功地.

受到全球数百万工程师的信任

IronPDF 是 IRON 的一部分套装

准备开始了吗？版本： 2024.9 刚刚发布

试用表格已提交
成功地.

试用表格已提交
成功地.

试用表格已提交
成功地.

试用表格已提交
成功地.

获取您的免费 30天试用密钥立即。

试用表格已提交
成功地.

获取您的免费 30天试用密钥立即。

获取您的免费 30天试用密钥立即。

试用表格已提交
成功地.