Tables

DrawTable draws a PdfTable in a rectangle: the rows that fit in its height, with the texts of the cells broken into lines that fit their columns. The result tells whether the table is complete; pass it to the next call to continue the table on another page:

var document = new PdfDocument();
var bold = PdfFont.GetStandardFont(PdfStandardFont.HelveticaBold);
var table = new PdfTable(
    new PdfTableColumn(PdfTableColumnWidth.Relative()), // the rest of the width
    new PdfTableColumn(PdfTableColumnWidth.Auto, PdfTextAlignment.Right), // the width of the widest cell
    new PdfTableColumn(PdfTableColumnWidth.Fixed(80), PdfTextAlignment.Right))
{
    FontSize = 10,
    CellPadding = 5,
    BorderColor = PdfColor.FromGray(0.6),
};

// The header rows are drawn again at the top of each page
var header = table.AddHeaderRow("Description", "Quantity", "Amount");
header.Font = bold;
header.Background = PdfColor.FromGray(0.9);

for (var i = 1; i <= 80; i++)
{
    table.AddRow($"Item {i}: the text of a cell is broken into lines that fit the width of its column", "1", "10.00 €");
}

var total = table.AddRow("Total", "", "800.00 €");
total.Font = bold;
total.Cells[0].ColumnSpan = 2;
total.Cells.RemoveAt(1);

// Draw the rows that fit in the area of the page, then continue on new pages
var area = new PdfRectangle(50, 50, PdfSize.A4.Width - 50, PdfSize.A4.Height - 50);
var result = document.Pages.Add(PdfSize.A4).CreateContentBuilder().DrawTable(table, area);
while (!result.IsComplete)
{
    result = document.Pages.Add(PdfSize.A4).CreateContentBuilder().DrawTable(table, area, result);
}

document.Save(outputPath);

Columns

Each PdfTableColumn has a width and the alignment of its cells. GetColumnWidths returns the widths the table gets in a width.

A table without relative columns is as wide as its columns, which can be less than the rectangle: add a relative column to fill it. The cells that span several columns (ColumnSpan) do not count in the automatic widths.

Rows and cells

AddRow adds a row from the texts of its cells, one per column; the columns after the last cell are empty. AddHeaderRow adds a header row and increments HeaderRowCount: the header rows are the first rows of the table, drawn again at the top of each continuation.

The style of a cell comes from the cell, then its row, then the table:

The table also sets the space between the borders and the text (CellPadding, 4 points), the borders (BorderWidth, 0.5 point, 0 for none, and BorderColor), the distance between the lines of a cell (LineHeight, 1.2 times the font size) and the Hyphenator of the words of the cells. The texts of the cells are broken into lines like the texts of a text box: see Wrap a paragraph.

Page breaks

• A row that does not fit in the height left is drawn at the top of the next rectangle, after the header rows. A row taller than a whole rectangle is split: the lines of its cells that fit are drawn, and the others continue in the next rectangle.
• When the first rectangle has no room for a row after the header rows (a table that starts at the bottom of a page), nothing is drawn and IsComplete is false: the table starts in the next rectangle. A rectangle too small for the header rows and a line of the next row throws InvalidOperationException.
• Bottom is the y coordinate of the bottom of the part drawn, to draw what follows the table below it.
• The rows are laid out before anything is drawn: a character a font cannot show throws ArgumentException and leaves the content of the page unchanged.