How to Use the Rendering Options

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

PDF生成中的渲染选项指的是确定如何创建、显示和打印PDF文档的设置和配置。 这些选项包括多种设置,例如渲染表单字段元素、启用JavaScript、生成目录、添加页眉和页脚、调整页边距、设置PDF纸张尺寸等。

IronPDF中的ChromePdfRenderer类提供了多种渲染选项,允许用户自定义PDF生成方式。 它包含PaperFit,一个管理器,可以控制PDF页面上的内容布局,提供响应式CSS3布局或连续输出等不同布局样式。

Nuget IconGet started making PDFs with NuGet now:

  1. Install IronPDF with NuGet Package Manager

    PM > Install-Package IronPdf

  2. Copy and run this code snippet.

    new IronPdf.ChromePdfRenderer { RenderingOptions = { PrintHtmlBackgrounds = true, MarginTop = 0, MarginBottom = 0, CssMediaType = IronPdf.Rendering.PdfCssMediaType.Print, HtmlHeader = new IronPdf.HtmlHeaderFooter { HtmlFragment = "<div>My Header</div>" }, Language = "en-US", Timeout = 120000 } }
        .RenderHtmlStringAsPdf("<h1>Hello Options</h1>")
        .SaveAs("renderingOptions.pdf");
  3. Deploy to test on your live environment

    Start using IronPDF in your project today with a free trial
    arrow pointer
class="hsg-featured-snippet">

简化工作流程(5个步骤)

  1. 下载C#库以使用渲染选项
  2. 准备要转换为PDF文档的HTML资产或文件
  3. 实例化ChromePdfRenderer类以渲染PDF
  4. 直接访问RenderingOptions属性来配置您的设置
  5. 以所需格式渲染PDF

## 渲染选项示例 尽管许多渲染选项属性专为HTML到PDF转换而设计,它们也可以在其他类型的PDF转换中使用。 让我们将Markdown语法渲染为PDF,并使用渲染选项配置PDF输出。 ```csharp :path=/static-assets/pdf/content-code-examples/how-to/rendering-options-render.cs ```
ChromePdfRenderer
描述 用于定义PDF打印选项,如纸张尺寸、DPI、页眉和页脚
属性/功能 类型 描述
CustomCookies Dictionary 用于HTML渲染的自定义cookie。Cookies在渲染之间不会持续存在,必须每次设置。
PaperFit VirtualPaperLayoutManager 用于设置虚拟纸张布局的管理器,控制内容如何在PDF“纸张”页面上布局。包括默认Chrome行为、缩放、响应式CSS3布局、按页扩展和连续输出样式PDF页面设置的选项。
UseMarginsOnHeaderAndFooter UseMargins 在渲染页眉和页脚时使用主文档的页边距值。
CreatePdfFormsFromHtml bool 将所有HTML表单元素转换为可编辑PDF表单。默认值为true。
CssMediaType PdfCssMediaType 启用媒体="screen"的CSS样式和样式表。默认值为PdfCssMediaType.Screen。
CustomCssUrl string 允许自定义CSS样式表在渲染之前应用于HTML。可以是本地文件路径或远程URL,仅在将HTML渲染为PDF时适用。
EnableJavaScript bool 允许在页面渲染前执行JavaScript和JSON,适合从Ajax/Angular应用程序打印。默认值为false。
EnableMathematicalLaTex bool 启用数学LaTeX元素的渲染。
Javascript string 在所有HTML加载完毕但在PDF渲染之前执行的自定义JavaScript字符串。
JavascriptMessageListener StringDelegate 在浏览器JavaScript控制台消息可用时调用的方法回调。
FirstPageNumber int 用于PDF页眉和页脚的首页页码。默认值为1。
TableOfContents TableOfContentsTypes 在HTML文档中id为"ironpdf-toc"的元素位置生成目录。
GrayScale bool 输出黑白PDF。默认值为false。
TextHeader ITextHeaderFooter 将每个PDF页的页脚内容设置为文本,支持“邮件合并”并自动将URL转换为超链接。
TextFooter
HtmlHeader HtmlHeaderFooter 将每个PDF页的页眉内容设置为HTML。支持“邮件合并”。
HtmlFooter
InputEncoding Encoding 输入字符编码作为字符串。默认值为Encoding.UTF8。
MarginTop double PDF“纸张”顶部边距(毫米)。对于无边和商业印刷应用设为零。默认值为25。
MarginRight double PDF“纸张”右边距(毫米)。对于无边和商业印刷应用设为零。默认值为25。
MarginBottom double PDF“纸张”底部边距(毫米)。对于无边和商业印刷应用设为零。默认值为25。
MarginLeft double PDF“纸张”左边距(毫米)。对于无边和商业印刷应用设为零。默认值为25。
PaperOrientation PdfPaperOrientation PDF纸张方向,如纵向或横向。默认值为纵向。
PaperSize PdfPaperSize 设置纸张尺寸
SetCustomPaperSizeinCentimeters double 以厘米设定纸张尺寸。
SetCustomPaperSizeInInches 以英寸设定纸张尺寸。
SetCustomPaperSizeinMilimeters 以毫米设定纸张尺寸。
SetCustomPaperSizeinPixelsOrPoints 以屏幕像素或打印点设定纸张尺寸。
PrintHtmlBackgrounds Boolean 是否打印HTML中的背景颜色和图像。默认值为true。
RequestContext RequestContexts 此渲染的请求上下文,决定对某些资源(如Cookies)的隔离。
Timeout Integer 渲染超时时间,以秒为单位。默认值为60。
Title String PDF文档名称和标题元数据,对邮件合并和IronPdf的MVC和Razor扩展自动文件命名有用。
ForcePaperSize Boolean 通过在HTML渲染为PDF后调整页面尺寸,强制页面尺寸与IronPdf.ChromePdfRenderOptions.PaperSize中指定的完全一致。帮助修正HTML转PDF渲染时的页面尺寸小错误。
WaitFor WaitFor 一个包装对象,持有用户等待某些事件触发前的等待机制配置。默认不会等待任何事件。