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. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Tag for the document element, specified as a character vector.

The DOM generates a session-unique tag when it creates the document element. Structure the tag as class:id, where class is the class of the element and id is the value of the Id property. You can specify a tag to replace the generated tag. Specifying your own tag can make it easier 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