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

Table コンテナ

最も複雑なデータをレイアウトするには、Table コンテナーを使用します。テーブルは PDF ドキュメントで重要な役割を果たし、明瞭性と効果を高めます。

表は、データを表示するための構造化された形式を提供します。表を使用すると、複雑な詳細を簡潔かつ視覚的に魅力的な方法で表示できます。長い段落の代わりに、表を使用して事実、数字、傾向を簡潔に表示できます。

適切に設計された表は読みやすさを向上させます。列と行を揃えることで、読者の目を誘導する構造を作成します。背景、境界線、フォントスタイルを使用して、特定のセルや見出しを強調できます。

Table コンテナ

LayoutContainer.Table メソッドを呼び出してテーブルコンテナーを取得します。次に、コンテナー内に少なくとも 1 つの列を定義する必要があります。最も単純なケースでは、Cell メソッドを複数回呼び出すことで、すべての列と行を埋めることができます。

列の定義方法、テーブルへのヘッダーやフッターの追加方法については、引き続きお読みください。このテキストでは、Table コンテナのその他のすべての機能についても説明します。

この記事は、PDF 生成のための Layout API に関するシリーズの一部です。 API を初めて使用する場合は、まず Layout API の使用開始の部分をお読みください。

Docotic.Pdf ライブラリ 9.5.17664-dev レイアウトアドオン 9.5.17664-dev
回帰テスト 14,820人が合格 NuGet の合計ダウンロード数 4,998,853

列と行

すべてのテーブルには少なくとも 1 つの列を定義する必要があります。列を定義するには、Table.Columns メソッドを使用します。このメソッドは、Action<TableColumnContainer> タイプのデリゲートを受け入れます。デリゲートコードで、提供されたオブジェクトのメソッドを呼び出して、テーブルに列を追加します。

ConstantColumn メソッドは、正確なポイント数に等しい幅の列を追加します。

RelativeColumn メソッドは、相対的な幅を持つ列を追加します。このメソッドは、列が占める部分の数を受け入れます。部分の合計数は、このテーブル内のすべての RelativeColumn 呼び出しのすべての数値の合計です。ほとんどの場合、このメソッドは Row コンテナーの RelativeItem と同じように機能します。詳細な説明については、リンクをお読みください。

行を明示的に定義する必要はありません。行の数は列とセルのプロパティによって決まります。セルの数も行の数に影響します。テーブルの高さは、すべての行の高さの合計よりも大きくなる場合があります。行のセルの数は列の数よりも少なくなる場合があります。また、列のセルの数は行の数よりも少なくなる場合があります。

PdfDocumentBuilder.Create().Generate("table-basic.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Size(300, 100);
        page.Content()
            .Padding(10)

            //.MinimalBox()

            .Border(b => b.Thickness(1).Color(new PdfRgbColor(250, 123, 5)))
            .Table(table =>
            {
                table.Columns(columns =>
                {
                    columns.ConstantColumn(100);
                    columns.RelativeColumn(1);
                    columns.RelativeColumn(3);
                });

                for (int i = 0; i < 10; i++)
                {
                    table.Cell()
                        .Border(b => b.Thickness(0.1))
                        .AlignCenter()
                        .Text($"Cell {i + 1}");
                }
            });
    });
});

コードの結果は table-basic.pdf で確認できます。

結果の PDF では、テーブルが親コンテナーのスペースをすべて占有します。領域をカバーするのに十分なセルがないにもかかわらずです。テーブルの高さを行の高さの合計に制限するには、MinimalBox 呼び出しのコメントを解除します。

このコードは 3 つの列を定義し、テーブルに 10 個のセルを追加します。テーブルはセルを次々に配置し、必要に応じて新しい行を追加します。行にセルが 1 つだけあっても問題ありません。

現在のページに十分なスペースがない場合、テーブルは次のページにセルを配置します。追加するセルの数を増やすことで、これを確認できます。

細胞

テーブルセルを操作するために Layout API が提供する機能について説明します。

位置

表のセルを作成する方法は 2 つあります:

明示的な位置情報なし
少なくとも部分的に位置を指定

前のセクションのコードでは、最初の方法を使用しました。パラメータを受け入れない Cell メソッドオーバーロードを呼び出します。このメソッドは、最後に追加されたセルの後の列に新しいセルを追加します。右側にスペースがない場合、セルは次の行に移動します。RTL モードでは、このメソッドは最後に追加されたセルの左側のスペースをチェックします。

新しいセルの正確な位置がわかっている場合は、Cell メソッドの別のオーバーロードを使用します。これは、Action<TableCell> 型のデリゲートを受け入れるオーバーロードです。デリゲートコードでは、提供されたオブジェクトの RowIndex メソッドと ColumnIndex メソッドを呼び出して、セルの行とインデックスを指定します。

新しいセルの行インデックスまたは列インデックスのみを指定することもできます。行インデックスのみを指定した場合、列インデックスは 0 になります。その逆も同様です。

セルを作成するときに、両方の Cell オーバーロードの呼び出しを任意の順序で混在させることができます。

この記事の次のコード例では、次の拡張メソッドを使用します。これにより、例がより簡潔になり、読みやすくなります。

static class LayoutHelpers
{
    public static TextSpan BoxWithText(this LayoutContainer cell, string caption)
        => cell.Border(b => b.Thickness(0.5))
            .Background(new PdfGrayColor(75))
            .ShowOnce()
            .MinWidth(50)
            .MinHeight(50)
            .Padding(10)
            .AlignCenter()
            .AlignMiddle()
            .Text(caption);
}

明示的に配置されたセルと暗黙的に配置されたセルの両方を含むテーブルを作成する例を次に示します。拡張メソッドを使用して、セルにスタイルとテキストを適用しました。セル内の数字は、セルの作成順序を反映しています。

PdfDocumentBuilder.Create().Generate("table-cells.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Size(300, 200);
        page.Content()
            .Padding(10)
            .MinimalBox()
            .Border(b => b.Thickness(0.1))
            .Table(table =>
            {
                table.Columns(columns =>
                {
                    for (int i = 0; i < 4; i++)
                        columns.RelativeColumn();
                });

                table.Cell().BoxWithText("1");
                table.Cell(c => c.RowIndex(1).ColumnIndex(1)).BoxWithText("2");
                table.Cell().BoxWithText("3");
                table.Cell(c => c.RowIndex(2).ColumnIndex(2)).BoxWithText("4");
                table.Cell(c => c.RowIndex(0).ColumnIndex(3)).BoxWithText("5");
            });
    });
});

コードの結果は table-cells.pdf で確認できます。

行と列の範囲

セルは複数の行や列にまたがることができます。デリゲートを受け入れる Cell オーバーロードを使用して、セルがまたがる行と列の数を指定します。

PdfDocumentBuilder.Create().Generate("table-cellspans.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Size(300, 150);
        page.Content()
            .Padding(10)
            .MinimalBox()
            .Border(b => b.Thickness(0.1))
            .Table(table =>
            {
                table.Columns(columns =>
                {
                    for (int i = 0; i < 4; i++)
                        columns.RelativeColumn();
                });

                table.Cell(c => c.RowSpan(2).ColumnSpan(2)).BoxWithText("1");
                table.Cell(c => c.ColumnSpan(2)).BoxWithText("2");
                table.Cell().BoxWithText("3");
                table.Cell().BoxWithText("4");
            });
    });
});

コードの結果は table-cellspans.pdf で確認できます。

重複

セルが互いに重なり合うことは可能です。その場合、作成順序によってどのセルが他のセルの上に重なるかが決まります。

セルが複数の列または行にまたがる場合、またはセルを明示的および暗黙的に配置する場合に、一部のセルが重なり合うことがあります。

PdfDocumentBuilder.Create().Generate("table-overlapping.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Size(300, 300);
        page.Content()
            .Padding(10)
            .MinimalBox()
            .Border(b => b.Thickness(0.1))
            .Table(table =>
            {
                table.Columns(columns =>
                {
                    for (int i = 0; i < 4; i++)
                        columns.RelativeColumn();
                });

                for (int i = 0; i < 16; i++)
                    table.Cell().BoxWithText($"{i + 1}");

                table.Cell(c => c.RowIndex(2).ColumnIndex(1).ColumnSpan(3))
                    .Background(new PdfRgbColor(250, 123, 5), 50);
            });
    });
});

コードの結果は table-overlapping.pdf で確認できます。

下まで延長

テーブルのレイアウトが複雑な場合、ページングメカニズムによって一部の列の下部に空白スペースが生じることがあります。空白スペースをなくしたい場合は、ExtendCellsToBottom メソッドを使用します。このメソッドは、各列の最後のセルを拡張して、セルがテーブルの下部で終了するようにします。

次の例では、最初のページにデフォルトの動作が示されています。2 番目のページには、ExtendCellsToBottom 呼び出しが列にどのように影響するかが示されています。

PdfDocumentBuilder.Create().Generate("table-extendcells.pdf", doc =>
{
    for (int take = 0; take < 2; take++)
    {
        doc.Pages(page =>
        {
            page.Size(300, 200);
            page.Content()
                .Padding(10)
                .MinimalBox()
                .Border(b => b.Thickness(0.1))
                .Table(table =>
                {
                    if (take != 0)
                        table.ExtendCellsToBottom();

                    table.Columns(columns =>
                    {
                        for (int i = 0; i < 4; i++)
                            columns.RelativeColumn();
                    });

                    table.Cell(c => c.RowIndex(0).ColumnIndex(0)).BoxWithText("1");
                    table.Cell(c => c.RowIndex(2).ColumnIndex(0)).BoxWithText("2");
                    table.Cell(c => c.RowIndex(1).ColumnIndex(1)).BoxWithText("3");
                    table.Cell(c => c.RowIndex(2).ColumnIndex(2)).BoxWithText("4");
                    table.Cell(c => c.RowIndex(1).ColumnIndex(3)).BoxWithText("5");
                });
        });
    }
});

コードの結果は table-extendcells.pdf で確認できます。

ヘッダーとフッター

テーブルにはヘッダーとフッターを設定できます。Header メソッドと Footer メソッドを使用して、対応する TableCellContainer にアクセスして設定します。コンテナーには、セルを作成するための Cell メソッドが用意されています。これらのメソッドは、メインのテーブルコンテンツのメソッドとまったく同じように機能します。

ヘッダー、フッター、およびメインテーブルセルは同じ列定義を使用します。ただし、3 つのセルコレクションはすべて独立しており、互いに影響しません。

表が 1 ページに収まらない場合は、表が占める各ページにヘッダーとフッターが繰り返されます。

前の例では、BoxWithText 拡張メソッドを使用しました。次のコードでも、WhiteBoxWithText 拡張メソッドを使用します。

static class LayoutHelpers
{
    public static TextSpan WhiteBoxWithText(
        this LayoutContainer cell, string caption, bool center = true)
    {
        return cell.Border(b => b.Thickness(0.5))
            .ShowOnce()
            .MinWidth(50)
            .MinHeight(50)
            .Padding(10)
            .Container(l => center ? l.AlignCenter() : l)
            .AlignMiddle()
            .Text(caption);
    }
}

次の例は、ヘッダー付きの表を作成する方法を示しています。5 つの必須化学元素を含む表を使用します。各元素の名前と融点が摂氏とケルビンの両方で示されています。

var elements = new (string Name, double Celsius, double Kelvin)[] {
    ("Oxygen", -218.79, 54.36),
    ("Carbon", double.NaN, double.NaN),
    ("Hydrogen", -259.16, 13.99),
    ("Nitrogen", -209.86, 63.23),
    ("Sulfur", 115.21, 388.36),
};

static string formatDouble(double val)
{
    return double.IsNaN(val)
        ? string.Empty
        : val.ToString(CultureInfo.InvariantCulture);
}

PdfDocumentBuilder.Create().Generate("table-header.pdf", doc =>
{
    doc.Pages(page =>
    {
        page.Size(400, 500);
        page.Content()
            .Padding(10)
            .MinimalBox()
            .Border(b => b.Thickness(0.1))
            .Table(table =>
            {
                table.Columns(columns =>
                {
                    columns.RelativeColumn();
                    columns.ConstantColumn(100);
                    columns.ConstantColumn(100);
                });

                table.Header(header =>
                {
                    header.Cell(c => c.RowSpan(2)).BoxWithText("Chemical element");
                    header.Cell(c => c.ColumnSpan(2)).BoxWithText("Melting point");

                    header.Cell().BoxWithText("Celsius");
                    header.Cell().BoxWithText("Kelvin");
                });

                foreach (var (Name, Celsius, Kelvin) in elements)
                {
                    table.Cell().WhiteBoxWithText(Name, false);

                    table.Cell().WhiteBoxWithText(formatDouble(Celsius));
                    table.Cell().WhiteBoxWithText(formatDouble(Kelvin));
                }
            });
    });
});

コードの結果は table-header.pdf で確認できます。

サンプルコード

PDF ドキュメントに表を追加するの例を確認してください。ヘッダー付きのテーブルを作成する方法も示されていますが、拡張メソッドは使用されていません。また、VB.NET バージョンもあります。

Table コンテナ

列と行

細胞

位置

行と列の範囲

重複

下まで延長

ヘッダーとフッター

サンプル コード

サンプルコード