TableRow.BreakAcrossPages Property

Specifies whether the table row can break across pages.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

bool BreakAcrossPages { get; set; }

VB.NET

Property BreakAcrossPages As Boolean

Property Value

Type	Description
Boolean	true to break the row across pages; otherwise, false.

Remarks

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

View Example

C#

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

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

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();
}

VB.NET

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

    wordProcessor.SaveDocument("DocumentWithTables.docx",
         DocumentFormat.OpenXml)
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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BreakAcrossPages property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-richedit-tables-simple-example/CS/TablesSimpleExample/Form1.cs#L73

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

word-document-api-table-examples/CS/TablesSimpleExample/Program.cs#L243

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

VB.NET

winforms-richedit-tables-simple-example/VB/TablesSimpleExample/Form1.vb#L61

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

word-document-api-table-examples/VB/TablesSimpleExample/Program.vb#L199

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