Main Content

mlreportgen.dom.WidowOrphanControl class

Package: mlreportgen.dom
Superclasses:

Widow and orphan handling

Description

Specifies whether to prevent widows and orphans. This format applies only to Microsoft® Word documents.

Construction

widowOrphanControlObj = WidowOrphanControl() prevents a page break after the first line of a paragraph (orphan) or before the last line of a paragraph (widow).

widowOrphanControlObj = WidowOrphanControl(tf) prevents orphans and widows if tf is true.

Input Arguments

expand all

A setting of true (or 1) prevents a page break after the first line of a paragraph (orphan) or before the last line of a paragraph (widow). A setting of false (or 0) allows a page break after the first line of a paragraph (orphan) or before the last line of a paragraph (widow).

Data Types: logical

Output Arguments

expand all

Widow and orphan handling, represented by an mlreportgen.dom.WidowOrphanControl 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 — Prevents a page break after the first line of a paragraph (orphan) or before the last line of a paragraph (widow).

  • false or 0 — Allows a page break after the first line of a paragraph (orphan) or before the last line of a paragraph (widow).

Data Types: logical