How to: Repeat Table Rows as Header

Feb 17, 2021

Word Processing Document API offers two options to control the appearance of large tables that span across multiple pages:

TableRow.RepeatAsHeaderRow - Repeats a header row at the top of each page;
TableRow.BreakAcrossPages - Specifies whether the row can be split when the table expands to another page.

The code sample below toggles Repeat row as header and Break row across pages options in code:

View Example

C#
VB.NET

csharp

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    AdjustTableRows(wordProcessor.Document);

    wordProcessor.SaveDocument("DocumentWithTables.docx",
         DocumentFormat.Docx);
}

private static void AdjustTableRows(Document document)
{
    Table table = document.Tables[0];
    table.BeginUpdate();

    //Repeat first three rows as header:
    table.Rows[0].RepeatAsHeaderRow = true;
    table.Rows[1].RepeatAsHeaderRow = true;
    table.Rows[2].RepeatAsHeaderRow = true;

    //Break last row across pages:
    table.LastRow.BreakAcrossPages = true;
    table.EndUpdate();
}

Using wordProcessor As New RichEditDocumentServer()
    AdjustTableRows(wordProcessor.Document)

    wordProcessor.SaveDocument("DocumentWithTables.docx",
         DocumentFormat.Docx)
End Using

private static void AdjustTableRows(Document document)
    Dim table As Table = document.Tables(0)
    table.BeginUpdate()

    'Repeat first three rows as header:
    table.Rows(0).RepeatAsHeaderRow = True
    table.Rows(1).RepeatAsHeaderRow = True
    table.Rows(2).RepeatAsHeaderRow = True

    'Break last row across pages:
    table.LastRow.BreakAcrossPages = True
    table.EndUpdate()
End Sub