Main Content

mlreportgen.dom.KeepLinesTogether class

Package: mlreportgen.dom
Superclasses:

Start paragraph on new page if necessary

Description

Start paragraph on new page if necessary

Construction

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

Output Arguments

expand all

Start paragraph on new page if necessary, represented by an mlreportgen.dom.KeepLinesTogether object.

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.

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.

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