Main Content

mlreportgen.dom.AllowBreakAcrossPages Class

Namespace: mlreportgen.dom

Allow row to straddle page break

expand all in page

Description

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

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

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

Properties

expand all

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

Object identifier for the mlreportgen.dom.AllowBreakAcrossPages object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Tag for the mlreportgen.dom.AllowBreakAcrossPages object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Version History

Introduced in R2014b

See Also

|

Topics