このページには自動翻訳されたテキストを含めることができます。

C# および VB.NET で HTML を PDF に変換する

すでに HTML 形式でのコンテンツの作成に多くの時間と費用を費やしている場合は、その HTML から PDF を作成したいと思うかもしれません。このようなアプローチは、重複した作業を避けたいと考えているすべての人にとって自然な方向です。

投資をうまく再利用するには、変換をプログラムで実行する必要があり、結果として得られる PDF は視覚的にソース HTML にできるだけ近いものにする必要があります。

HTMLからPDFへの変換

.NET アプリケーションでの HTML から PDF への変換用 API

Docotic.Pdf ライブラリ用の無料の HTML to PDF アドオンは、このような変換のための API を提供します。アドオンとライブラリはどちらも、.NET および .NET Core フレームワーク用に構築された Web アプリケーションおよびデスクトップアプリケーションから使用できます。

Docotic.Pdf ライブラリ 9.5.17615-dev HTMLからPDFへのアドオン 9.5.17615-dev
回帰テスト 14,813人が合格 NuGet の合計ダウンロード数 4,924,084

このアドオンは、変換中に Chromium を使用する HTML to PDF .NET ライブラリです。各変換の前に、アドオンは、サポートされている最新の Chromium が既にダウンロードされているかどうかを自動的にチェックします。すでにダウンロードされている対象バージョンは再利用されます。対象となるバージョンが見つからない場合、アドオンは変換前にバージョンをダウンロードします。 Google Chrome(R)と同様のWeb標準準拠が期待されます。

このアドオンは、Windows、macOS、および Linux 環境で HTML から PDF を生成できます。 Linux でアドオンを構成する方法については、記事 Azure での HTML から PDF への変換についてをご覧ください。

アドオンは NuGet およびライブラリのバイナリを含む zip で入手できます。ライブラリ、アドオン、および期間限定の無料ライセンスキーは、C# .NET PDF ライブラリをダウンロードページで入手できます。

シンプルな HTML から PDF C# への変換

HTML to PDF API を使用すると、C# 変換コードは次のようになります:

static async Task convertUrlToPdfAsync(string urlString, string pdfFileName)
{
    using (var converter = await HtmlConverter.CreateAsync())
    {
        using (var pdf = await converter.CreatePdfAsync(new Uri(urlString)))
            pdf.Save(pdfFileName);
    }
}

それはかなり単純です。 PDF ドキュメントを生成するために必要な呼び出しは 2 回だけです。ご覧のとおり、API は非同期であり、同期メソッドをまったく提供しません。

同期コードから API を呼び出したい場合は、次のラッパーを使用できます:

Task.Run(async () =>
{
    await convertUrlToPdfAsync("https://bitmiracle.com/", "output.pdf");
}).GetAwaiter().GetResult();

一般に、非同期メソッドを同期的に呼び出すことは推奨されないため、他に選択肢がない場合にのみラッパーを使用してください。

同期コンソールアプリケーションと非同期コンソールアプリケーションの両方から API の使用方法を示すサンプルコードを提供します。また、Windows フォームおよび WPF アプリケーションのサンプルコードもあります。

HTML to PDF サンプルグループもあります。各サンプルには C# バージョンと VB.NET バージョンが付属しています。

C# および VB.NET で HTML 文字列またはファイルを含む PDF を作成する

API を使用すると、HTML 文字列を PDF に簡単に変換できます。文字列には、完全な HTML ドキュメントまたは断片のみを含めることができます。コンバーターは HTML コードから PDF を作成します。

var html = "<body><br><br><br><h1>Hello, World<h1></body>";
using (var pdf = await converter.CreatePdfFromStringAsync(html))
    pdf.Save("output.pdf");

変換する HTML コード内のすべての相対リンクのベース URL を指定できます。以下は、C# でベース URL を使用して HTML を PDF に変換する方法のコードスニペットです。

var incompleteHtml = "<img src=\"/images/team.svg\"></img>";
var options = new HtmlConversionOptions();
options.Load.BaseUri = new Uri("https://bitmiracle.com/");
using (var pdf = await converter.CreatePdfFromStringAsync(incompleteHtml, options))
    pdf.Save("output.pdf");

HTML ファイルの変換は、URL の変換とほぼ同じです。 URL の代わりにパスを受け入れる CreatePdfAsync オーバーロードを使用するだけです。 C# または VB.NET コードで HTML ファイルを PDF に変換する場合、ベース URL およびその他のオプションもサポートされます。

var sampleHtmlPath = @"C:\path\to\sample.html";
using (var pdf = await converter.CreatePdfAsync(sampleHtmlPath))
    pdf.Save("output.pdf");

API を使用して SVG 画像を PDF に変換することもできます。

カスタムのページサイズ、余白、スケールを使用する

PDF 作成メソッドに変換オプションを提供することで、HTML から PDF C# への変換を設定できます。

以下は、C# で出力ページのサイズ、余白、スケールを構成する方法を示すコードスニペットです:

using (var converter = await HtmlConverter.CreateAsync())
{
    var options = new HtmlConversionOptions();

    // ページの向きを横向きにするかどうかを指定したり、
    // サイズをポイントまたはインチで指定したりすることもできます
    options.Page.SetSize(PdfPaperSize.ItalyEnvelope);

    options.Page.MarginLeft = 10;
    options.Page.MarginTop = 20;
    options.Page.MarginRight = 30;
    options.Page.MarginBottom = 40;

    options.Page.Scale = 1.5;

    using (var pdf = await converter.CreatePdfAsync(url, options))
        pdf.Save("output.pdf");
}

ヘッダーとフッターのテンプレートを指定する

ページオプションを使用して、ヘッダーテンプレートとフッターテンプレートを指定できます。テンプレートでは、いくつかの変数をサポートする通常の HTML コードを使用します。これらの変数は、date、title、url、pageNumber、および totalPages です。ヘッダーテンプレートとフッターテンプレートは、同じ変数セットをサポートします。

画像にはインラインスタイルとデータ URI を使用することをお勧めします。

ページの上下の余白を指定したい場合があります。余白がないと、ヘッダーまたはフッターがページのコンテンツによって隠れてしまう可能性があります。

Convert HTML to PDF with header and footer in C# or VB.NET サンプルコードは、テンプレートで変数とデータ URI を使用する方法を示しています。

パスワードで保護された HTML から PDF C# への変換

HTML ページがユーザー名とパスワードのペアで保護されている場合でも、PDF を作成できます。 HtmlConversionOptions 内で認証オプションを設定するのと同じくらい簡単です。

var options = new HtmlConversionOptions();
options.Authentication.SetCredentials("foo", "bar");

using (var pdf = await converter.CreatePdfAsync(url, options))
    pdf.Save("output.pdf");

ページが適切に機能するためにいくつかの Cookie を設定する必要がある場合も簡単です。これらの Cookie をオプションに追加するだけです。その方法は次のとおりです:

var options = new HtmlConversionOptions();
options.Cookies.Add(new Cookie("sessionID", "my-session-ID"));

using (var pdf = await converter.CreatePdfAsync(url, options))
    pdf.Save("output.pdf");

変換開始を遅らせる

デフォルトでは、変換はロード直後に開始されます。ただし、ページが安定するまでに時間がかかる場合があります。たとえば、いくつかの計算を実行し、それらの計算の準備ができた後に内容を更新する場合です。

変換開始オプションを使用すると、指定したミリ秒数だけ変換を遅延できます。

// 変換を開始する前に 10 秒待ちます。
var options = new HtmlConversionOptions();
options.Start.SetStartAfterDelay(10 * 1000);

場合によっては、読み込まれたページ上の要素を切り替えるため、または動的なコンテンツの読み込みを行うために、スクリプトを実行することが必要になります。これも可能です:

var options = new HtmlConversionOptions();
var js = @"
    async function scrollDownUntilYouCantAnyMore() {
        await new Promise((resolve, reject) => {
            // 簡潔にするために省略
            }, 400);
        });
    }
    scrollDownUntilYouCantAnyMore();
";
options.Start.SetStartAfterScriptRun(js);
using (var pdf = await converter.CreatePdfAsync(url, options))
    pdf.Save("output.pdf");

C# または VB.NET でスクリプトを実行した後の HTML から PDF サンプルコードには、完全な scrollDownUntilYouCantAnyMore 関数が含まれています。このサンプルでは、HTML から PDF に変換する前にスクリプトを実行する方法を示します。

.NET で SSL エラーを無視して HTML を PDF に変換する

変換中に SSL エラーが発生する可能性があります。このようなエラーは通常、自己署名証明書または信頼できない証明書が原因で発生します。失効した証明書や期限切れの証明書によっても、HTML から PDF へのコンバーターが例外をスローする可能性があります。

SSL エラーが発生する理由を理解し、無視しても安全であると確信できる場合は、SSL エラーを無視できます。 HTML から PDF への変換中に SSL エラーを無視するには、エンジンオプションを IgnoreSslErrors = true で使用します。

var engineOptions = new HtmlEngineOptions
{
    IgnoreSslErrors = true
};
using (var converter = await HtmlConverter.CreateAsync(engineOptions))
{
    var url = new Uri("https://self-signed.badssl.com/");
    using (var pdf = await converter.CreatePdfAsync(url))
        pdf.Save("output.pdf");
}

HTML コンテンツを PDF ページ上に配置する

HTML を変換し、変換結果を既存の PDF ページの上に置く必要がある場合があります。たとえば、フォームの画像がある場合、その画像の空の領域に何かを配置したい場合があります。結果は入力されたフォームのようになります。

変換された HTML を既存の PDF コンテンツの上に置くには、次の操作を行う必要があります:

HTMLから背景が透明なPDFページを作成します
変換されたページから XObject を作成します
既存の PDF ページ上に XObject を描画します。

既存の PDF に HTML を重ねるのサンプルコードにすべての手順が示されています。サンプルをご覧ください。