如何使用渲染选项
在 PDF 生成中,渲染选项指的是决定 PDF 文档如何创建、显示和打印的设置和配置。 这些选项可以包括广泛的设置,例如渲染表单字段元素、启用JavaScript、生成目录、添加页眉和页脚、调整边距、设置PDF纸张大小等。
IronPDF 中的ChromePdfRenderer类提供了各种渲染选项,允许用户自定义 PDF 的生成方式。 它包括PaperFit,一个管理器,用于控制内容在PDF页面上的布局,提供不同的布局样式,例如响应式CSS3布局或连续滚动。
开始使用IronPDF
立即在您的项目中开始使用IronPDF,并享受免费试用。
如何使用渲染选项
- 下载 C# 库以使用渲染选项
- 准备要转换为PDF文档的HTML资产或文件
- 实例化ChromePdfRenderer类来渲染PDF
- 直接访问RenderingOptions属性以配置您的设置
- 将 PDF 渲染为所需格式
渲染选项示例
尽管许多渲染选项属性是专为HTML到PDF转换设计的,它们也可以用于其他类型的PDF转换。 让我们将Markdown语法渲染为PDF,并使用渲染选项配置PDF输出。
:path=/static-assets/pdf/content-code-examples/how-to/rendering-options-render.csusing 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呈现选项,例如调整页边距,
纸张方向、纸张尺寸等。
下表展示了多种不同的选项。
| Class | ChromePdfRenderer | |
|---|---|---|
| Description | Used to define PDF print out options, like paper size, DPI, headers and footers | |
| Properties / functions | Type | Description |
| CustomCookies | Dictionary<string, string> | Custom cookies for the HTML render. Cookies do not persist between renders and must be set each time. |
| PaperFit | VirtualPaperLayoutManager | A manager for setting up virtual paper layouts, controlling how content will be laid out on PDF "paper" pages. Includes options for Default Chrome Behavior, Zoomed, Responsive CSS3 Layouts, Scale-To-Page & Continuous Feed style PDF page setups. |
| UseMarginsOnHeaderAndFooter | UseMargins | Use margin values from the main document when rendering headers and footers. |
| CreatePdfFormsFromHtml | bool | Turns all HTML form elements into editable PDF forms. Default value is true. |
| CssMediaType | PdfCssMediaType | Enables Media="screen" CSS Styles and StyleSheets. Default value is PdfCssMediaType.Screen. |
| CustomCssUrl | string | Allows a custom CSS style-sheet to be applied to HTML before rendering. May be a local file path or a remote URL. Only applicable when rendering HTML to PDF. |
| EnableJavaScript | bool | Enables JavaScript and JSON to be executed before the page is rendered. Ideal for printing from Ajax / Angular Applications. Default value is false. |
| EnableMathematicalLaTex | bool | Enables rendering of Mathematical LaTeX Elements. |
| Javascript | string | A custom JavaScript string to be executed after all HTML has loaded but before PDF rendering. |
| JavascriptMessageListener | StringDelegate | A method callback to be invoked whenever a browser JavaScript console message becomes available. |
| FirstPageNumber | int | First page number to be used in PDF Headers and Footers. Default value is 1. |
| TableOfContents | TableOfContentsTypes | Generates a table of contents at the location in the HTML document where an element is found with id "ironpdf-toc". |
| GrayScale | bool | Outputs a black-and-white PDF. Default value is false. |
| TextHeader | ITextHeaderFooter | Sets the footer content for every PDF page as text, supporting 'mail-merge' and automatically turning URLs into hyperlinks. |
| TextFooter | ||
| HtmlHeader | HtmlHeaderFooter | Sets the header content for every PDF page as HTML. Supports 'mail-merge'. |
| HtmlFooter | ||
| InputEncoding | Encoding | The input character encoding as a string. Default value is Encoding.UTF8. |
| MarginTop | double | Top PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications. Default value is 25. |
| MarginRight | double | Right PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications. Default value is 25. |
| MarginBottom | double | Bottom PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications. Default value is 25. |
| MarginLeft | double | Left PDF "paper" margin in millimeters. Set to zero for border-less and commercial printing applications. Default value is 25. |
| PaperOrientation | PdfPaperOrientation | The PDF paper orientation, such as Portrait or Landscape. Default value is Portrait. |
| PaperSize | PdfPaperSize | Sets the paper size |
| SetCustomPaperSizeinCentimeters | double | Sets the paper size in centimeters. |
| SetCustomPaperSizeInInches | Sets the paper size in inches. | |
| SetCustomPaperSizeinMilimeters | Sets the paper size in millimeters. | |
| SetCustomPaperSizeinPixelsOrPoints | Sets the paper size in screen pixels or printer points. | |
| PrintHtmlBackgrounds | Boolean | Indicates whether to print background-colors and images from HTML. Default value is true. |
| RequestContext | RequestContexts | Request context for this render, determining isolation of certain resources such as cookies. |
| Timeout | Integer | Render timeout in seconds. Default value is 60. |
| Title | String | PDF Document Name and Title metadata, useful for mail-merge and automatic file naming in the IronPdf MVC and Razor extensions. |
| ForcePaperSize | Boolean | Force page sizes to be exactly what is specified via IronPdf.ChromePdfRenderOptions.PaperSize by resizing the page after generating a PDF from HTML. Helps correct small errors in page size when rendering HTML to PDF. |
| WaitFor | WaitFor | A wrapper object that holds configuration for wait-for mechanism for users to wait for certain events before rendering. By default, it will wait for nothing. |




