如何使用渲染選項
在 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.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不會在渲染之間持續,必須每次都設置。 |
紙適 | 虛擬紙張佈局管理器 | 一個用於設置虛擬紙張佈局的管理器,控制內容在 PDF「紙張」頁面上的佈局方式。包括默認的 Chrome 行為、縮放、響應式 CSS3 佈局、按頁比例縮放和連續輸送樣式的 PDF 頁面設置選項。 |
使用頁首和頁腳的邊距 | 使用邊距 | 在渲染頁眉和頁腳時使用主文檔的邊距值。 |
從Html創建Pdf表單 | 布林值 | 將所有 HTML 表單元素轉換為可編輯的 PDF 表單。默認值為 true。 |
CssMediaType | PdfCssMediaType | 啟用媒體="螢幕" CSS 樣式和樣式表。預設值為 PdfCssMediaType.Screen。 |
自訂Css網址 | 字串 | 允許在渲染之前將自定義 CSS 樣式表應用於 HTML。可以是本地檔案路徑或遠端 URL。僅在將 HTML 渲染為 PDF 時適用。 |
啟用JavaScript | 布林值 | 在頁面渲染之前允許執行 JavaScript 和 JSON。非常適合從 Ajax / Angular 應用程式列印。預設值為 false。 |
啟用數學LaTex | 布林值 | 啟用渲染數學 LaTeX 元素。 |
JavaScript | 字串 | 在所有 HTML 加載完成但在 PDF 渲染之前執行的自定義 JavaScript 字串。 |
JavaScript訊息監聽器 | 字串委派 | 當瀏覽器的 JavaScript 控制台訊息變為可用時,將調用的方法回調。 |
第一頁號碼 | 整數 | PDF 頁眉和頁腳中使用的第一頁頁碼。預設值為 1。 |
目錄 | 目錄類型 | 在 HTML 文件中找到 id 為 "ironpdf-toc" 的元素所在位置生成目錄。 |
灰度 | 布林值 | 輸出黑白 PDF。預設值為 false。 |
文本標題 | ITextHeaderFooter | 設定每個PDF頁面的頁腳內容為文字,支持「郵件合併」並自動將URL變為超連結。 |
文本頁腳 | ||
HtmlHeader | 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 擴展中的郵件合併和自動文件命名。 |
強制紙張尺寸 | 布林值 | 透過IronPdf.ChromePdfRenderOptions.PaperSize指定的強制頁面大小,在從HTML生成PDF後調整頁面大小。幫助修正將HTML渲染成PDF時頁面大小的小錯誤。 |
等待 | 等待 | 一個封裝物件,包含用於等待機制的配置,以便用戶在渲染之前等待某些事件。預設情況下,將不會等待任何事件。 |