レンダリングオプションの使用方法
PDF生成時のレンダリングオプションは、PDFドキュメントの作成、表示、および印刷方法を決定する設定と構成を指します。 これらのオプションには、フォームフィールド要素のレンダリング、JavaScriptの有効化、目次の生成、ヘッダーとフッターの追加、余白の調整、PDF用紙サイズの設定など、さまざまな設定が含まれます。
IronPDFのChromePdfRendererクラスは、ユーザーがPDFの生成方法をカスタマイズできるようにするさまざまなレンダリングオプションを提供します。 それには、PaperFit が含まれています。これは、PDF ページ上のコンテンツのレイアウトを管理するマネージャで、レスポンシブ CSS3 レイアウトや連続フィードなど、さまざまなレイアウトスタイルを提供します。
IronPDFを始めましょう
今日から無料トライアルでIronPDFをあなたのプロジェクトで使い始めましょう。
レンダリングオプションの使用方法
- レンダリング オプションを使用するためにC#ライブラリをダウンロード
- PDF文書に変換するためのHTMLアセットやファイルを準備してください。
- PDFをレンダリングするためにChromePdfRendererクラスをインスタンス化します。
- 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");
すべてのレンダリングオプション
次の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. |