Main Content

mlreportgen.dom.KeepLinesTogether Class

Namespace: mlreportgen.dom

Start paragraph on new page if necessary

expand all in page

Description

Start paragraph on new page if necessary

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

Creation

Description

keepLinesTogetherObj = KeepLinesTogether starts a paragraph on a new page if it cannot fit entirely on current page.

keepLinesTogetherObj = KeepLinesTogether(onoff) starts paragraph on a new page only if it cannot fit entirely on current page and onoff is true.

Input Arguments

expand all

Use one of these values:

  • true (default)

  • false

  • 0

A setting of true (or 1) starts a paragraph on a new page when it cannot fit entirely on the current page. A setting of false (or 0) allows a paragraph to span two pages when it cannot fit entirely on the current page.

Data Types: logical

Properties

expand all

Object identifier for the mlreportgen.dom.KeepLinesTogether 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.KeepLinesTogether 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

Possible values are:

  • true or 1 — Starts paragraph on a new page when it cannot fit entirely on the current page.

  • false or 0 — Allows the paragraph to span two pages when it cannot fit entirely on the current page.

Data Types: logical

Version History

Introduced in R2014b

See Also

|

Topics