Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.dom.AllowBreakAcrossPages class

Package: mlreportgen.dom
Superclasses:

Allow row to straddle page break

Description

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

Construction

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

expand all

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

Data Types: logical

Output Arguments

expand all

Specification of table row page break handling, represented by an mlreportgen.dom.AllowBreakAcrossPages object.

Properties

expand all

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

The possible values are:

  • 0— forces a row to start on the next page when it cannot fit on the current page

  • 1— allows a row to flow onto the next page when it cannot fit entirely on the current page

Data Types: logical

Was this topic helpful?