Main Content

mlreportgen.dom.AllowBreakAcrossPages class

Package: 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

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

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

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

Version History

Introduced in R2014b

See Also

|

Topics