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

C# および VB.NET で PDF ドキュメントを作成する

.NET 開発者として、PDF レポート、請求書、領収書、またはその他の文書を生成する必要がありますか? Docotic.Pdf ライブラリを使用して、.NET Core、.NET Standard、または .NET Framework プロジェクトで PDF ドキュメントを生成します。 PDF 形式についてまったく知らなくても、これを簡単に行うことができます。

PDF 生成用の .NET API

Docotic.Pdf は、外部依存関係のない 100% マネージドコードライブラリです。これを使用して、Windows、Linux、Amazon、Azure クラウド環境で PDF ドキュメントを作成できます。 macOS、iOS、Androidなどのクラウド環境でも大丈夫です。

ライブラリには、PDF ドキュメントを生成するためのさまざまな方法が用意されています。まず、高レベルのレイアウト API を使用して、ページヘッダーとフッター、表、段落を追加し、コンテンツをページに自動的に分割できます。レイアウト API は無料の Docotic.Pdf.Layout アドオンで利用できます。

または、HTML to PDF アドオン (こちらも無料) を使用して、HTML テンプレートに基づいて PDF ドキュメントを作成できます。詳細については、HTML を PDF に変換するの記事を参照してください。

また、コアライブラリ API を使用して PDF ドキュメントを作成できます。あらゆる PDF コンテンツ - テキスト、画像、ベクターグラフィックスをサポートします。)、フォーム、注釈、ブックマーク、レイヤー、およびその他。ただし、コア API は、ヘッダー、テーブル、セクションなどの高レベルのレイアウトコンポーネントをサポートしません。コアライブラリを使用する場合は、コンテンツを測定し、PDF ページ間で自分で分割する必要があります。

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

コアライブラリとアドオンを併用することもできます。たとえば、レイアウト API を使用して PDF ドキュメントを生成し、コアライブラリを使用してさらにコンテンツを追加します。レイアウトアドオンは、.NET Standard 2.1、.NET Core、.NET 5 以降のフレームワークをサポートしていることに注意してください。コアライブラリと HTML to PDF アドオンは、.NET Standard 2.0、.NET 4.7.2+、.NET Core、.NET 5 以降をサポートします。

Docotic.Pdf アドオンは NuGet で入手でき、ライブラリのバイナリ付き zip に含まれています。評価モードの制限なしでライブラリを試すには、ここで無料の期間限定ライセンスキーを入手できます。

レイアウト API を使用して PDF ドキュメントを作成する

この C# サンプルでは、レイアウト API を使用して C# で PDF ドキュメントを生成する方法を示します:

PdfDocumentBuilder
    .Create()
    .Generate("long-text.pdf", doc => doc.Pages(page =>
    {
        string text = File.ReadAllText(@"C# in Depth, Fourth Edition.txt");
        page.Content().Text(text);

        page.Footer().AlignCenter().Text(t => t.CurrentPageNumber());
    }));

このコードはテキストファイルを PDF に変換します。長いテキストをページに分割し、フッター領域にページ番号も描画します。テキストの高さを計算したり、ページ数を数えたりする必要はありません。これらの日常的なタスクはライブラリが処理します。

レイアウト API は流暢な API です。ほとんどの呼び出しは連鎖できるため、「宣言型」フレームワークよりもコンパクトなコードを作成できます。 API をさらに詳しく見てみましょう。

PDF ドキュメントのプロパティを設定する

PDF の生成は PdfDocumentBuilder クラスから始まります。生成された PDF ドキュメントのプロパティを指定できます。たとえば、メタデータ、暗号化、PDF バージョンを設定したり、高速 Web ビューを有効にしたりできます。基本的な C# サンプルは次のとおりです:

PdfDocumentBuilder
    .Create()
    .Encryption(new PdfStandardEncryptionHandler("owner", "user"))
    .Info(info =>
    {
        info.Author = "Docotic.Pdf library";
        info.Title = "How to create PDF in .NET";
        info.Keywords = "C#, VB.NET";
    })
    .Version(PdfVersion.Pdf16)
    .Generate("result.pdf", doc => doc.Pages(_ => {}));

このサンプルでは、カスタムメタデータを含む空のパスワードで保護された PDF ドキュメントを作成し、ファイルに保存します。 PdfDocumentBuilder.Generate(Stream, ..) オーバーロードを使用して、ドキュメントをストリームに保存することもできます。

PdfDocumentBuilder をセットアップしたら、PDF ドキュメントにコンテンツを入力します。レイアウト API は、共通リソース (タイポグラフィ、画像) を登録し、PDF ページコンテンツを定義するための Document オブジェクトを提供します。 PdfDocumentBuilder.Generate メソッドの 2 番目の引数で Document を設定できます。 PDF ページを設定する方法を学びましょう。

PDF ページレイアウトを定義する

この C# サンプルでは、A3 ページを横向きにした PDF ドキュメントを作成する方法を示します:

PdfDocumentBuilder.Create().Generate("pages.pdf", doc =>
{
    doc.Pages((PageLayout page) =>
    {
        page.Size(PdfPaperSize.A3, PdfPaperOrientation.Landscape)
            .MarginVertical(50)
            .MarginHorizontal(40);

        page.Header().PaddingBottom(30).AlignRight().Text("Hello PDF");

        page.Content().Column(c =>
        {
            c.Item().Text("Page 1");
            c.Item().PageBreak();
            c.Item().Text("Page 2");
        });

        page.Footer().Text(t => t.CurrentPageNumber());
    });
});

Document.Pages() メソッドは、1 つ以上のページのレイアウトを定義します。まず、サンプルコードでは、すべてのページに共通の設定 (サイズ、方向、余白) を設定します。コンテンツの方向、デフォルトのテキストスタイル、または背景色を指定することもできます。

次に、サンプルはページレイアウトとコンテンツを生成します。 PageLayout クラスは、ページコンテンツを次のスロットに配置するためのメソッドを提供します。

Background() - 他のコンテンツで覆われた背景レイヤー
Header() - すべてのページに共通のヘッダー
Content() - メインページのコンテンツ
Footer() - すべてのページに共通のフッター
Foreground() - 他のコンテンツを覆う前景レイヤー

レイアウトエンジンは、PageLayout.Content() スロットに追加されたコンテンツに応じてページを生成します。他のスロットはページごとに繰り返されます。 LayoutContainer クラスを使用して、スロットにコンテンツを追加できます。これはレイアウト API の重要な構成要素であり、任意のレイアウト、テーブル、テキスト、または画像を生成できるようになります。

前のサンプルでは、コンテンツを垂直に積み重ねる LayoutContainer.Column メソッドを使用しています。この列には、最初のページのテキストチャンク、明示的な改ページ、2 番目のページのテキストチャンクの 3 つの項目が含まれています。

LayoutContainer.Row メソッドもあります。行と列を一緒に使用して複数列の PDF ドキュメントを作成する方法を参照してください。

PDF ドキュメント内でさまざまなページレイアウトを混在させることができます。 Document.Pages メソッドを複数回呼び出すだけです。例については、GitHub の PDF ページレイアウト設定サンプルを参照してください。

PDF ドキュメントにテキストを追加する

テキストは PDF ドキュメントの重要な部分です。 LayoutContainer.Text メソッドを使用してテキストを追加できます。前に、LayoutContainer.Text(string) オーバーロードの使用例を見てきました。このメソッドの別のオーバーロードを見てみましょう:

PdfDocumentBuilder.Create().Generate("text.pdf", doc =>
{
    doc.Pages(p => p.Content().Text(text =>
    {
        text.Span("VB.NET").Style(t => t.Strong);
        text.Span(" is a multi-paradigm, object-oriented programming language, implemented on.NET, Mono, and the ");
        text.Hyperlink(".NET Framework", new Uri("https://dotnet.microsoft.com/en-us/download/dotnet-framework"));
        text.Line(".");

        text.Line("Microsoft launched VB.NET in 2002 as the successor to its original Visual Basic language.");
    }));
});

TextContainer クラスは、テキスト、リンク、ページ番号を描画するメソッドを提供します。現在の行にテキストを追加するには、Span メソッドと Line メソッドを使用します。 Line メソッドはさらに現在の行を完成させます。このサンプルでは、外部リソースリンクを追加する Hyperlink メソッドも使用します。

これは、ページフッターで動的なページ番号を使用する方法を示す別のサンプルです:

PdfDocumentBuilder.Create().Generate("footer.pdf", doc =>
{
    doc.Pages(p => p.Footer().AlignRight().Text(text =>
    {
        text.Style(t => t.Parent.FontColor(new PdfRgbColor(255, 0, 0)));

        text.CurrentPageNumber();
        text.Span(" / ");
        text.PageCount();
    }));
});

レイアウト API は、ページ番号をフォーマットする方法を提供します。たとえば、次のように 16 進数のページ番号を描画できます:

text.CurrentPageNumber().Format(p => "0x" + p?.ToString("x2"));

C# および VB.NET サンプルで PDF ドキュメントにヘッダーとフッターを追加するは、ページ番号をローマ数字としてフォーマットする方法を示しています。

上記のサンプルでは Style メソッドが使用されていることがわかります。テキストスタイルの概念をさらに詳しく調べてみましょう。

タイポグラフィ

テキストスタイルを使用すると、テキストの外観をカスタマイズできます。 TextStyle クラスは、フォントサイズ、文字間隔、色、その他のテキストプロパティを変更するメソッドを提供します。 TextStyle オブジェクトは不変であるため、メソッド呼び出しごとに新しいテキストスタイルが生成されます。さまざまなレイアウトレベルでテキストスタイルを適用できます:

PdfDocumentBuilder.Create().Generate("text-styles.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.TextStyle(TextStyle.Parent.FontSize(30));

        page.Content()
            .TextStyle(TextStyle.Parent.FontColor(new PdfRgbColor(0, 0, 255)))
            .Text(t =>
            {
                t.Style(TextStyle.Parent.Underline());

                t.Span("Hello PDF").Style(TextStyle.Parent.DirectionRightToLeft());
            });
    });
});

TextStyle.Parent プロパティは、すべてのテキストプロパティが未定義の特別なスタイルを返します。前のサンプルでは、"Hello PDF" を青色の下線付きの 30 ポイントのフォントサイズで逆順 (右から左) に描画します。別のテキストスタイル継承の例については、PDF ドキュメントのテキストの外観をカスタマイズするサンプルを参照してください。

TextStyle クラスは、関連付けられたフォントを除くすべてのカスタマイズをサポートします。テキストスタイルのカスタムフォントを指定する必要がある場合は、Document.TextStyleWithFont メソッドを使用します。この C# サンプルは、システムフォントの使用方法を示しています:

PdfDocumentBuilder.Create().Generate("fonts.pdf", doc =>
{
    doc.Pages(page =>
    {
        TextStyle style = doc.TextStyleWithFont(SystemFont.Family("Arial").Bold());
        page.Content().Text("Bold text").Style(style);
    });
});

レイアウトエンジンは、デフォルトで未使用のフォントグリフを削除します。このため、大きなフォントでも生成されるドキュメントのサイズが小さくなる場合があります。カスタムフォントローダー、フォールバックフォント、不足しているグリフのハンドラーを指定することもできます。詳細については、PDF ドキュメントで異なるフォントを使用するサンプルを参照してください。

レイアウト API は、事前定義されたスタイルのコレクションを提供します。 Typography クラスを介して使用またはカスタマイズできます:

PdfDocumentBuilder.Create().Generate("typography.pdf", doc =>
{
    doc.Typography(t =>
    {
        var baseFont = new FileInfo("arial.ttf");
        t.Document = doc.TextStyleWithFont(baseFont);
        t.Header = t.Parent.FontSize(20).FontColor(new PdfGrayColor(20));
        t.Footer = t.Footnote;
    });

    doc.Pages(page =>
    {
        page.Header().AlignCenter().Text("Header");

        page.Content().Text(t =>
        {
            t.Line("Title").Style(t => t.Title);
            t.Line("Heading 1").Style(t => t.Heading1);
            t.Line("Regular");
        });

        page.Footer().Height(20).AlignCenter().Text(t => t.CurrentPageNumber());
    });
});

Typography クラスを使用すると、テキストスタイルの参照を保持するために変数を使用する必要はありません。 Document.Typography メソッドを使用して必要なスタイルを登録し、後でそれらを Typography オブジェクトから読み込みます。 Typography サンプルで定義済みスタイルとカスタムスタイルの使用方法を確認してください。

画像

テキストやフォントと同様に、画像も PDF ドキュメントの基本的な部分です。レイアウト API を使用すると、そのような画像を追加できます:

PdfDocumentBuilder.Create().Generate("image.pdf", doc =>
{
    var imageFile = new FileInfo("image.jpg");
    Image image = doc.Image(imageFile);
    doc.Pages(page => page.Content().MaxWidth(200).Image(image));
});

テーブル

レイアウト API を使用すると、テーブルを生成できます。この C# サンプルは、PDF ドキュメントに表を追加する方法を示しています:

PdfDocumentBuilder.Create().Generate("table.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Content().Table(t =>
        {
            t.Columns(c =>
            {
                c.ConstantColumn(200);
                c.RelativeColumn(1);
            });

            t.Header(h =>
            {
                h.Cell().Text("Product");
                h.Cell().Text("Features");
            });

            t.Cell().Text("Docotic.Pdf");
            t.Cell().Text("Extract text, PDF to images, compress PDF");
            t.Cell().Text("Docotic.Pdf.Layout");
            t.Cell().Text("Create PDF");
        });
    });
});

任意の複雑さのテーブルを作成できます。このサンプルは、セルの境界線、背景、およびスパンの使用方法を示しています。

内部リンク

PDF ドキュメントは、ブックマークや目次を生成できる内部リンクをサポートしています。この基本的な C# サンプルは、レイアウト API を使用してドキュメントセクションにリンクを追加する方法を示しています:

PdfDocumentBuilder.Create().Generate("link.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Content().Column(c =>
        {
            const string SectionName = "Chapter 1";
            c.Item().SectionLink(SectionName).Text("Link");

            c.Item().PageBreak();

            c.Item().Section(SectionName).Text("Target");
        });
    });
});

GitHub から PDF ドキュメントに目次を追加サンプルをダウンロードして試すこともできます。

複雑なレイアウト

さまざまなレイアウトコンポーネントを組み合わせて、複雑な PDF ドキュメントを生成できます。 GitHub から複雑なレイアウトで PDF ドキュメントを生成するサンプルをダウンロードして試してください。

レイアウトAPIを拡張することが可能です。 LayoutContainer.Component メソッドと LayoutContainer.Container メソッドを使用すると、カスタムコンポーネントを再利用できます。レイアウトコンポーネントサンプルは、ILayoutComponent インターフェイスを使用してカスタムコンポーネントを実装する方法を示しています。

結論

Docotic.Pdf ライブラリは、C# および VB.NET で PDF ドキュメントを作成するためのさまざまな手段を提供します。レイアウトアドオンを使用しても、使用しなくても、PDF ドキュメントを最初から生成できます。または、HTML to PDF アドオンを使用して HTML から PDF を作成することもできます。

PDF の生成についてご質問がある場合は、お問い合わせまでお問い合わせください。

C# および VB.NET で PDF ドキュメントを作成する

PDF 生成用の .NET API

レイアウト API を使用して PDF ドキュメントを作成する

PDF ドキュメントのプロパティを設定する

PDF ページレイアウトを定義する

PDF ドキュメントにテキストを追加する

タイポグラフィ

画像

テーブル

内部リンク

複雑なレイアウト

結論

関連リソース