mlreportgen.dom.AllowBreakAcrossPages Class

Namespace: mlreportgen.dom

Allow row to straddle page break

Description

Specifies whether to allow row to straddle page break. This format applies only to Word and PDF documents.

This class is only compatible with these MATLAB^® Report Generator™ output types:

• "docx"

• "pdf"

• "pdfa" (since R2025a)

The mlreportgen.dom.AllowBreakAcrossPages class is a handle class.

Creation

Description

breakAcrossPagesObj = AllowBreakAcrossPages allows a row to flow onto the next page when it cannot fit entirely on the current page.

breakAcrossPagesObj = AllowBreakAcrossPages(tf) forces a row to start on the next page when it cannot fit on the current page and tf = false.

Input Arguments

tf — Whether to allow row to flow onto next page

true (default) | logical value

A setting of 0 (false) forces a row to start on the next page when it cannot fit on the current page. A setting of 1 (true) allows a row to flow onto the next page when it cannot fit entirely on the current page.

Data Types: logical

Properties

Value — Whether to allow row to flow onto next page

1 (true) (default) | 0 (false)

Whether to allow a row to flow onto the next page, specified as a logical 1 (true) or 0 (false). When you specify:.

• 1 (true) — Allows a row to flow onto the next page when it cannot fit entirely on the current page.

• 0 (false) — Forces a row to start on the next page when it cannot fit on the current page.

Data Types: logical

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Version History

Introduced in R2014b

R2026a: Use AllowBreakAcrossPages in PDF reports

You can use AllowBreakAcrossPages to specify whether to allow a table row to straddle a page break in PDF reports.