如何使用渲染选项
在 PDF 生成中,渲染选项指的是决定 PDF 文档如何创建、显示和打印的设置和配置。 这些选项可以包括广泛的设置,例如渲染表单字段元素、启用JavaScript、生成目录、添加页眉和页脚、调整边距、设置PDF纸张大小等。
IronPDF 中的 ChromePdfRenderer 类提供了多种渲染选项,使用户可以自定义 PDF 的生成方式。 它包括PaperFit,一个管理器,用于控制内容在PDF页面上的布局,提供不同的布局样式,例如响应式CSS3布局或连续滚动。
开始使用IronPDF
立即在您的项目中开始使用IronPDF,并享受免费试用。
如何使用渲染选项
- 下载 C# 库以使用渲染选项
- 准备要转换为PDF文档的HTML资产或文件
- 实例化 ChromePdfRenderer 用于渲染PDF的类
- 访问 渲染选项 直接通过属性配置您的设置
- 将 PDF 渲染为所需格式
渲染选项示例
尽管许多渲染选项属性是专为HTML到PDF转换设计的,它们也可以用于其他类型的PDF转换。 让我们将Markdown语法渲染为PDF,并使用渲染选项配置PDF输出。
:path=/static-assets/pdf/content-code-examples/how-to/rendering-options-render.cs
using IronPdf;
// Instantiate Renderer
ChromePdfRenderer renderer = new ChromePdfRenderer();
// Configure rendering options
renderer.RenderingOptions.PrintHtmlBackgrounds = true;
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter()
{
HtmlFragment = "<h1>Header Content</h1>"
};
renderer.RenderingOptions.SetCustomPaperSizeinMilimeters(150, 150);
renderer.RenderingOptions.MarginTop = 0;
// Markdown string
string md = "This is some **bold** and *italic* text.";
// Render from markdown string
PdfDocument pdf = renderer.RenderMarkdownStringAsPdf(md);
// Save the PDF
pdf.SaveAs("renderingOptions.pdf");
Imports IronPdf
' Instantiate Renderer
Private renderer As New ChromePdfRenderer()
' Configure rendering options
renderer.RenderingOptions.PrintHtmlBackgrounds = True
renderer.RenderingOptions.HtmlHeader = New HtmlHeaderFooter() With {.HtmlFragment = "<h1>Header Content</h1>"}
renderer.RenderingOptions.SetCustomPaperSizeinMilimeters(150, 150)
renderer.RenderingOptions.MarginTop = 0
' Markdown string
Dim md As String = "This is some **bold** and *italic* text."
' Render from markdown string
Dim pdf As PdfDocument = renderer.RenderMarkdownStringAsPdf(md)
' Save the PDF
pdf.SaveAs("renderingOptions.pdf")
所有渲染选项
我们有一些高级选项可以定义PDF呈现选项,例如调整页边距,
纸张方向、纸张尺寸等。
下表展示了多种不同的选项。
班级 | ChromePdfRenderer | |
---|---|---|
说明 | 用于定义 PDF 打印选项,如纸张大小、DPI、页眉和页脚 | |
属性/功能 | 类型 | 说明 |
自定义 Cookies | Dictionary<string, string>; | 用于 HTML 渲染的自定义 Cookie。Cookie 不会在两次渲染之间持续存在,每次都必须设置。 |
PaperFit | 虚拟纸张布局管理器 | 这是一款用于设置虚拟纸张布局的管理器,可控制 PDF "纸张 "页面的内容布局。包括默认 Chrome 浏览器行为、缩放、响应式 CSS3 布局、缩放至页面 & 连续进纸式 PDF 页面设置等选项。 |
在页眉和页脚使用边距 | 使用边距 | 在渲染页眉和页脚时,使用主文档中的页边距值。 |
从 HTML 创建 PDFFormsFromHtml | bool | 将所有 HTML 表单元素转化为可编辑的 PDF 表单。默认值为 true。 |
CssMediaType | PdfCssMediaType | 启用 Media="screen" CSS 样式和样式表。默认值为 PdfCssMediaType.Screen。 |
自定义 CSSUrl | 字符串 | 允许在呈现之前将自定义 CSS 样式表应用于 HTML。可以是本地文件路径或远程 URL。仅适用于将 HTML 呈现为 PDF 时。 |
启用 JavaScript | bool | 可在页面渲染前执行 JavaScript 和 JSON。非常适合从 Ajax / Angular 应用程序打印。默认值为 false。 |
启用数学语言版本 | bool | 启用数学 LaTeX 元素的渲染。 |
Javascript | 字符串 | 自定义 JavaScript 字符串,将在加载所有 HTML 之后、PDF 渲染之前执行。 |
JavascriptMessageListener | StringDelegate | 浏览器 JavaScript 控制台消息可用时调用的方法回调。 |
首页编号 | int | PDF 页眉和页脚中使用的第一个页码。默认值为 1。 |
目录 | 内容表类型 | 在 HTML 文档中找到 id 为 "ironpdf-toc "元素的位置生成目录。 |
灰度 | bool | 输出黑白 PDF。默认值为假。 |
文本标题 | ITextHeaderFooter | 将每个 PDF 页面的页脚内容设置为文本,支持 "邮件合并 "并自动将 URL 转变为超链接。 |
文本页脚 | ||
标题 | HtmlHeaderFooter | 将每个 PDF 页面的页眉内容设置为 HTML。支持 "邮件合并"。 |
HtmlFooter | ||
输入编码 | 编码 | 字符串形式的输入字符编码。默认值为 Encoding.UTF8。 |
边距顶部 | 双人 | PDF 顶部 "纸张 "页边距,单位为毫米。对于无边框和商业印刷应用,设置为零。默认值为 25。 |
右边距 | 双人 | PDF 右 "纸 "边距,单位为毫米。对于无边框和商业印刷应用,设置为零。默认值为 25。 |
底部边距 | 双人 | PDF 底部 "纸张 "边距,单位为毫米。对于无边框和商业印刷应用,设置为零。默认值为 25。 |
左侧边距 | 双人 | PDF 左 "纸 "边距,单位为毫米。对于无边框和商业印刷应用,设置为零。默认值为 25。 |
纸张方向 | PdfPaperOrientation | PDF 纸张方向,如纵向或横向。默认值为纵向。 |
纸张尺寸 | PdfPaperSize | 设置纸张大小 |
设置自定义纸张大小(以厘米为单位 | 双人 | 以厘米为单位设置纸张大小。 |
设置自定义纸张尺寸(英寸 | 以英寸为单位设置纸张大小。 | |
设置自定义纸张尺寸(以毫米为单位 | 以毫米为单位设置纸张大小。 | |
以像素或点为单位设置自定义纸张尺寸 | 以屏幕像素或打印机点为单位设置纸张大小。 | |
打印 HTML 背景 | 布尔型 | 表示是否从 HTML 打印背景颜色和图像。默认值为 true。 |
请求上下文 | 请求上下文 | 该呈现的请求上下文,决定某些资源(如 cookie)的隔离。 |
超时 | 整数 | 渲染超时(秒)。默认值为 60。 |
标题 | 字符串 | PDF 文档名称和标题元数据,在 IronPdf MVC 和 Razor 扩展中用于邮件合并和自动文件命名。 |
强制纸张大小 | 布尔型 | 在从 HTML 生成 PDF 后,通过调整页面大小,强制页面大小与通过 IronPdf.ChromePdfRenderOptions.PaperSize 指定的完全一致。在将 HTML 渲染为 PDF 时,有助于纠正页面大小的微小错误。 |
等待 | 等待 | 封装对象,用于保存等待机制的配置,以便用户在渲染前等待特定事件。默认情况下,它不会等待任何事件。 |