レンダリングオプションの使用方法
PDF生成時のレンダリングオプションは、PDFドキュメントの作成、表示、および印刷方法を決定する設定と構成を指します。 これらのオプションには、フォームフィールド要素のレンダリング、JavaScriptの有効化、目次の生成、ヘッダーとフッターの追加、余白の調整、PDF用紙サイズの設定など、さまざまな設定が含まれます。
IronPDFのChromePdfRendererクラスは、ユーザーがPDFの生成方法をカスタマイズできるようにするさまざまなレンダリングオプションを提供します。 それには、PaperFit が含まれています。これは、PDF ページ上のコンテンツのレイアウトを管理するマネージャで、レスポンシブ CSS3 レイアウトや連続フィードなど、さまざまなレイアウトスタイルを提供します。
IronPDFを始めましょう
今日から無料トライアルでIronPDFをあなたのプロジェクトで使い始めましょう。
レンダリングオプションの使用方法
- レンダリングオプションを使用するためのC#ライブラリをダウンロードする
- PDF文書に変換するためのHTMLアセットやファイルを準備してください。
- インスタンス化する ChromePdfRenderer(クロームPDFレンダラー) 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レンダラー) | |
---|---|---|
説明 | PDF印刷オプション(用紙サイズ、DPI、ヘッダーおよびフッターなど)を定義するために使用されます。 | |
プロパティ / 関数 | タイプ | 説明 |
カスタムクッキー | Dictionary<string, string> (辞書辞典<文字列, 文字列>) | HTMLレンダー用のカスタムクッキー。クッキーはレンダー間で持続せず、毎回設定する必要があります。 |
ペーパーフィット | バーチャルペーパー・レイアウトマネージャー | PDF「ペーパー」ページ上にコンテンツを配置する方法を制御する仮想ペーパーのレイアウトを設定するマネージャー。デフォルトのChrome動作、ズーム機能、レスポンシブCSS3レイアウト、ページに合わせたスケーリング、連続フィードスタイルのPDFページ設定オプションを含みます。 |
ヘッダーとフッターに余白を使用 | UseMargins(余白を使用) | ヘッダーとフッターをレンダリングする際にメインドキュメントのマージン値を使用します。 |
HTMLからPDFフォームを作成 | ブール | すべてのHTMLフォーム要素を編集可能なPDFフォームに変換します。デフォルト値はtrueです。 |
CssMediaType | PdfCssMediaType(CSSメディアタイプ) | メディア="screen" の CSS スタイルおよびスタイルシートを有効にします。デフォルト値は PdfCssMediaType.Screen です。 |
カスタムCSS URL | 文字列 | HTMLをレンダリングする前にカスタムCSSスタイルシートを適用することができます。ローカルファイルパスまたはリモートURLが使用可能です。HTMLからPDFへレンダリングする場合にのみ適用されます。 |
JavaScriptを有効にする | ブール | ページがレンダリングされる前にJavaScriptとJSONを実行できるようにします。Ajax / Angularアプリケーションからの印刷に最適です。デフォルト値はfalseです。 |
数式LaTeXを有効化 | ブール | 数式のLaTeX要素のレンダリングを可能にします。 |
JavaScript | 文字列 | すべてのHTMLが読み込まれた後、PDFレンダリングの前に実行されるカスタムJavaScript文字列。 |
JavaScriptMessageListener | StringDelegate(ストリングデリゲート) | ブラウザのJavaScriptコンソールメッセージが利用可能になるたびに呼び出されるメソッドコールバック。 |
ファーストページナンバー | int | PDFヘッダーおよびフッターに使われる最初のページ番号。デフォルト値は1です。 |
目次 | TableOfContentsTypes 目次タイプ | HTMLドキュメント内でidが「ironpdf-toc」の要素が見つかる場所に目次を生成します。 |
グレースケール | ブール | 白黒のPDFを出力します。デフォルト値はfalseです。 |
テキストヘッダー | ITextHeaderFooter (注:ここではブランド名を英語のまま保持しています) | すべてのPDFページのフッター内容をテキストとして設定し、「メールマージ」に対応し、URLを自動的にハイパーリンクに変換します。 |
テキストフッター | ||
HtmlHeader | HTMLヘッダーとフッター | すべてのPDFページに対するヘッダーコンテンツをHTMLとして設定します。「メールマージ」をサポートしています。 |
HtmlFooter(HTMLフッター) | ||
入力エンコーディング | エンコーディング | 入力文字エンコーディングを文字列として指定します。デフォルト値はEncoding.UTF8です。 |
マージントップ | ダブル | 上側のPDF「用紙」余白のミリメートル単位の数値。縁なし印刷や商用印刷の用途ではゼロに設定します。デフォルト値は25です。 |
右余白 | ダブル | 右側のPDF「用紙」の余白(ミリメートル)。ボーダーレスおよび商業印刷アプリケーションの場合は0に設定します。デフォルト値は25です。 |
マージンボトム | ダブル | 下部 PDF「紙」余白はミリメートル単位です。ボーダーレスや商業印刷アプリケーションの場合は0に設定します。デフォルト値は25です。 |
マージンレフト | ダブル | 左側のPDF「用紙」余白をミリメートルで指定します。境界なしや商業印刷用途の場合は0に設定してください。デフォルト値は25です。 |
用紙の向き | PdfPaperOrientation(PDF用紙の向き) | PDF用紙の向き(縦や横など)。デフォルト値は縦です。 |
用紙サイズ | PdfPaperSize (ペーパサイズ) | 用紙サイズを設定します |
SetCustomPaperSizeinCentimeters(センチメートルでカスタム用紙サイズを設定) | ダブル | 紙サイズをセンチメートルで設定します。 |
インチでカスタム用紙サイズを設定 | インチで用紙サイズを設定します。 | |
ミリメートル単位でのカスタム用紙サイズの設定 | 用紙サイズをミリメートルで設定します。 | |
SetCustomPaperSizeinPixelsOrPoints (カスタム用紙サイズをピクセルまたはポイントで設定) | 画面ピクセルまたはプリンターポイントで用紙サイズを設定します。 | |
背景を含むHTMLの印刷 | ブール値 | HTMLから背景色や画像を印刷するかどうかを示します。デフォルト値はtrueです。 |
リクエストコンテキスト | リクエストコンテキスト | このレンダリングのためのコンテキストを要求し、クッキーなどの特定のリソースの分離を決定します。 |
タイムアウト | 整数 | レンダータイムアウトの秒数。デフォルト値は60です。 |
タイトル | 文字列 | IronPdf MVCおよびRazor拡張機能で、メールマージや自動ファイル命名に便利なPDFドキュメント名とタイトルのメタデータ。 |
ForcePaperSize(フォースペーパーサイズ) | ブール値 | IronPdf.ChromePdfRenderOptions.PaperSizeを使用して指定されたページサイズと正確に一致するように、HTMLからPDFを生成した後にページをリサイズします。HTMLをPDFにレンダリングする際のページサイズの小さな誤差を修正するのに役立ちます。 |
待機 | 待機 | 特定のイベントがレンダリング前に起こるのを待つための待機機構の設定を保持するラッパーオブジェクトです。デフォルトでは、何も待機しません。 |