Main Content

mlreportgen.dom.KeepWithNext class

Package: mlreportgen.dom
Superclasses:

Keep paragraph on same page as next

Description

Keep paragraph on same page as the paragraph that follows it. This format applies to Microsoft® Word and PDF documents.

Construction

obj = KeepWithNext() keeps a paragraph on the same page as the paragraph that follows it.

obj = KeepWithNext(onoff) keeps a paragraph on the same page as the paragraph that follows it if onoff is true.

Input Arguments

expand all

Use one of these values:

  • true (default)

  • false

  • 1

  • 0

A setting of true (or 1) keeps a paragraph on the same page as the paragraph that follows it. A setting of false (or 0) allows a paragraph to be on a different page from the paragraph that follows it.

Data Types: logical

Output Arguments

expand all

Keep paragraph on same page as next, represented by an mlreportgen.dom.keepWithNext 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.

Use one of these values:

  • true or 1 — Keeps a paragraph on the same page as the paragraph that follows it.

  • false or 0 — Allows a paragraph to be on a different page from the paragraph that follows it.

Data Types: logical