ASP.NET CoreでHTMLをPDFに変換する -- IronPDFガイド

生成されたPDFはどのように見えますか?

ChromePdfRenderer クラスはすべての複雑なレンダリングを処理し、HTML 構造、CSS スタイル、さらにはJavaScript が最終的な PDF 出力で正しくレンダリングされることを保証します。 戻り値はオブジェクトであり、そのプロパティをファイルダウンロードとしてブラウザに直接ストリーミングできます。

動的な HTML 文字列を変換するにはどうすればよいですか?

データベース駆動型レポートなどの動的コンテンツを扱う場合は、RenderHtmlAsPdf を使用して HTML 文字列を直接変換します。 このメソッドは、有効な HTML マークアップを受け入れ、完全にレンダリングされた PDF を返します。

var renderer = new ChromePdfRenderer();
string htmlContent = BuildDynamicHtml(); // your method to generate HTML
var pdf = renderer.RenderHtmlAsPdf(htmlContent);
pdf.SaveAs("dynamic-report.pdf");

var renderer = new ChromePdfRenderer();
string htmlContent = BuildDynamicHtml(); // your method to generate HTML
var pdf = renderer.RenderHtmlAsPdf(htmlContent);
pdf.SaveAs("dynamic-report.pdf");

Dim renderer As New ChromePdfRenderer()
Dim htmlContent As String = BuildDynamicHtml() ' your method to generate HTML
Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
pdf.SaveAs("dynamic-report.pdf")

このアプローチは、リアルタイム データ、フォーム送信、または動的に生成されたコンテンツが取り込まれた HTML テンプレートから PDF ドキュメントを生成する場合に適しています。 レンダリング エンジンは、カスタム フォント、色、表の書式設定など、すべての CSS スタイルを保持します。 HTMLで相対パスを使用して外部スタイルシートや画像を参照する場合は、レンダラーがそれらのアセットを正しく解決できるように、2番目の引数としてbaseUrlを渡してください。

ディスクから静的 HTML ファイルを変換するにはどうすればよいでしょうか?

物理ファイルとして保存されている HTML テンプレートの場合、最初にメモリにロードせずに変換するには、RenderHtmlFileAsPdf を使用します。これは、大きなテンプレートに対して効率的であり、文字列の連結を回避します。

var renderer = new ChromePdfRenderer();
var pdf = renderer.RenderHtmlFileAsPdf("wwwroot/templates/report-template.html");
pdf.SaveAs("report.pdf");

var renderer = new ChromePdfRenderer();
var pdf = renderer.RenderHtmlFileAsPdf("wwwroot/templates/report-template.html");
pdf.SaveAs("report.pdf");

Dim renderer As New ChromePdfRenderer()
Dim pdf = renderer.RenderHtmlFileAsPdf("wwwroot/templates/report-template.html")
pdf.SaveAs("report.pdf")

このメソッドは、ファイル内で参照されているCSSスタイルシート、画像、その他の外部リソースの相対パスを自動的に解決します。デザインチームがアプリケーションのC#コードベースとは別にHTMLテンプレートファイルを保持している場合に適しています。 このメソッドはCSS 印刷メディア クエリとカスタム フォントをサポートしているため、印刷環境用に構築されたテンプレートは追加の構成なしで忠実にレンダリングされます。

Web ページの URL を PDF に変換するにはどうすればよいですか?

ライブウェブページをキャプチャしたり、URLでアクセス可能なページをPDFとしてレンダリングするには、RenderUrlAsPdfを使用します。 このメソッドは Chrome エンジンを起動し、URL に移動し、ページが完全に読み込まれるまで待機してから、レンダリングされた出力をキャプチャします。

var renderer = new ChromePdfRenderer();
renderer.RenderingOptions.EnableJavaScript = true;
renderer.RenderingOptions.WaitFor.RenderDelay(1000);
renderer.RenderingOptions.CssMediaType = PdfCssMediaType.Screen;
var pdf = renderer.RenderUrlAsPdf("https://en.wikipedia.org/wiki/PDF");
pdf.SaveAs("webpage.pdf");

var renderer = new ChromePdfRenderer();
renderer.RenderingOptions.EnableJavaScript = true;
renderer.RenderingOptions.WaitFor.RenderDelay(1000);
renderer.RenderingOptions.CssMediaType = PdfCssMediaType.Screen;
var pdf = renderer.RenderUrlAsPdf("https://en.wikipedia.org/wiki/PDF");
pdf.SaveAs("webpage.pdf");

Dim renderer = New ChromePdfRenderer()
renderer.RenderingOptions.EnableJavaScript = True
renderer.RenderingOptions.WaitFor.RenderDelay(1000)
renderer.RenderingOptions.CssMediaType = PdfCssMediaType.Screen
Dim pdf = renderer.RenderUrlAsPdf("https://en.wikipedia.org/wiki/PDF")
pdf.SaveAs("webpage.pdf")

WaitFor.RenderDelay オプションは、レンダラーにページ読み込み後にキャプチャする前に一時停止するように指示します。 これは、最初の HTML 応答が到着した後にJavaScriptを通じて DOM を構築するシングルページ アプリケーションに役立ちます。 EnableJavaScript = true を設定すると、Chrome for JavaScriptエンジンが完全に有効になり、グラフ、データグリッド、その他の JavaScript でレンダリングされたコンポーネントが、ブラウザで表示されるのと同様に PDF に表示されます。

フォームインターフェースはどのように見えますか?

生成された PDF にフォーム データはどのように表示されますか?

より高度なドキュメント シナリオでは、 PDF フォームを統合したり、事前に入力されたフィールドを使用して既存の PDF テンプレートを編集したりできます。 このライブラリは、法的文書や契約書のデジタル署名もサポートしており、生成された文書に暗号的に検証可能な署名を追加できます。

ユーザー データを HTML 文字列に埋め込むときに考慮すべき重要な点の 1 つは、サニタイズです。 インジェクションの問題を防ぐために、ユーザー指定の文字列を HTML に挿入する前に必ずエスケープしてください。 各フィールドに対してシンプルな System.Web.HttpUtility.HtmlEncode(model.CustomerName) 呼び出しを行うことで、テンプレートをレンダラーに渡す前に安全性を確保できます。

ヘッダー、フッター、透かしをどのように設定しますか?

プロフェッショナルな PDF ドキュメントでは、多くの場合、各ページにヘッダーとフッターが必要であり、ドラフトや機密ドキュメントには透かしも必要です。 IronPDF は、RenderingOptions オブジェクトのプロパティと、結果として得られる PdfDocument のメソッドを介して両方を処理します。

var renderer = new ChromePdfRenderer();
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter
{
    MaxHeight = 25,
    HtmlFragment = "<div style='text-align:center'>Annual Report 2024</div>"
};
renderer.RenderingOptions.HtmlFooter = new HtmlHeaderFooter
{
    MaxHeight = 20,
    HtmlFragment = "<div style='text-align:center'>Page {page} of {total-pages}</div>"
};
var pdf = renderer.RenderHtmlAsPdf(htmlContent);
pdf.ApplyWatermark("<h2 style='color:red;opacity:0.3'>CONFIDENTIAL</h2>",
    30, VerticalAlignment.Middle, HorizontalAlignment.Center);
pdf.SaveAs("report-with-watermark.pdf");

var renderer = new ChromePdfRenderer();
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter
{
    MaxHeight = 25,
    HtmlFragment = "<div style='text-align:center'>Annual Report 2024</div>"
};
renderer.RenderingOptions.HtmlFooter = new HtmlHeaderFooter
{
    MaxHeight = 20,
    HtmlFragment = "<div style='text-align:center'>Page {page} of {total-pages}</div>"
};
var pdf = renderer.RenderHtmlAsPdf(htmlContent);
pdf.ApplyWatermark("<h2 style='color:red;opacity:0.3'>CONFIDENTIAL</h2>",
    30, VerticalAlignment.Middle, HorizontalAlignment.Center);
pdf.SaveAs("report-with-watermark.pdf");

Imports IronPdf

Dim renderer As New ChromePdfRenderer()
renderer.RenderingOptions.HtmlHeader = New HtmlHeaderFooter With {
    .MaxHeight = 25,
    .HtmlFragment = "<div style='text-align:center'>Annual Report 2024</div>"
}
renderer.RenderingOptions.HtmlFooter = New HtmlHeaderFooter With {
    .MaxHeight = 20,
    .HtmlFragment = "<div style='text-align:center'>Page {page} of {total-pages}</div>"
}
Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
pdf.ApplyWatermark("<h2 style='color:red;opacity:0.3'>CONFIDENTIAL</h2>", 30, VerticalAlignment.Middle, HorizontalAlignment.Center)
pdf.SaveAs("report-with-watermark.pdf")

フッターHTML内のプレースホルダー{total-pages}はレンダリング時に自動的に置き換えられるため、後処理なしで正しいページ番号が得られます。 ページ番号、背景画像または前景オーバーレイ、カスタムテキストまたは画像スタンプを追加することもできます。

PDF レイアウト制御に CSS 印刷メディアを使用する方法

PDF 出力が期待どおりになるようにするには、CSS の @media print ルールと PdfCssMediaType.Print 設定を使用します。 IronPDF はページ区切りの制御とカスタム用紙サイズを完全にサポートします。

var renderer = new ChromePdfRenderer();
renderer.RenderingOptions.CssMediaType = PdfCssMediaType.Print;
renderer.RenderingOptions.ViewPortWidth = 1024;
renderer.RenderingOptions.MarginTop = 10;
renderer.RenderingOptions.MarginBottom = 10;
renderer.RenderingOptions.MarginLeft = 10;
renderer.RenderingOptions.MarginRight = 10;
string html = @"
    <style>
        @media print {
            .no-print { display: none; }
            body { font-size: 12pt; }
            .page-break { page-break-after: always; }
        }
        @page {
            size: A4;
            margin: 1cm;
        }
    </style>
    <div class='content'>
        <h1>Professional Report</h1>
        <div class='page-break'></div>
        <h2>Section 2</h2>
    </div>";
var pdf = renderer.RenderHtmlAsPdf(html);

var renderer = new ChromePdfRenderer();
renderer.RenderingOptions.CssMediaType = PdfCssMediaType.Print;
renderer.RenderingOptions.ViewPortWidth = 1024;
renderer.RenderingOptions.MarginTop = 10;
renderer.RenderingOptions.MarginBottom = 10;
renderer.RenderingOptions.MarginLeft = 10;
renderer.RenderingOptions.MarginRight = 10;
string html = @"
    <style>
        @media print {
            .no-print { display: none; }
            body { font-size: 12pt; }
            .page-break { page-break-after: always; }
        }
        @page {
            size: A4;
            margin: 1cm;
        }
    </style>
    <div class='content'>
        <h1>Professional Report</h1>
        <div class='page-break'></div>
        <h2>Section 2</h2>
    </div>";
var pdf = renderer.RenderHtmlAsPdf(html);

Imports IronPdf

Dim renderer As New ChromePdfRenderer()
renderer.RenderingOptions.CssMediaType = PdfCssMediaType.Print
renderer.RenderingOptions.ViewPortWidth = 1024
renderer.RenderingOptions.MarginTop = 10
renderer.RenderingOptions.MarginBottom = 10
renderer.RenderingOptions.MarginLeft = 10
renderer.RenderingOptions.MarginRight = 10

Dim html As String = "
    <style>
        @media print {
            .no-print { display: none; }
            body { font-size: 12pt; }
            .page-break { page-break-after: always; }
        }
        @page {
            size: A4;
            margin: 1cm;
        }
    </style>
    <div class='content'>
        <h1>Professional Report</h1>
        <div class='page-break'></div>
        <h2>Section 2</h2>
    </div>"

Dim pdf = renderer.RenderHtmlAsPdf(html)

印刷用CSSを使用することで、ナビゲーションメニューやインタラクティブボタンなどの不要なウェブ要素を隠しながら、PDF文書がプロフェッショナルな書式を維持できるようになります。 CssMediaType = PdfCssMediaType.Print を設定すると、レンダラーは画面スタイルではなく @media print ルールを適用するようになります。通常、画面スタイルでは背景の装飾が削除され、印刷出力用にタイポグラフィが調整されます。 また、ページごとにカスタム余白を構成したり、ワイド形式または回転したレポートのページの向きと回転を制御したりすることもできます。

W3C CSS Paged Media 仕様では、 widows などのプロパティがページ出力でどのように動作するかが定義されています。 IronPDF の Chrome エンジンはこの仕様に厳密に従うため、CSS 標準に従って記述されたスタイルは手動で調整することなく PDF に正確に変換されます。