mlreportgen.dom.WidowOrphanControl Class

Namespace: mlreportgen.dom

Widow and orphan handling

Description

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

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

Creation

Description

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

tf — Controls orphans and widows

true (default) | false | 1 | 0

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

Properties

Id — Object identifier for mlreportgen.dom.WidowOrphanControl object

character vector | string scalar

Object identifier for the mlreportgen.dom.WidowOrphanControl 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 — Tag for mlreportgen.dom.WidowOrphanControl object

character vector | string scalar

Tag for the mlreportgen.dom.WidowOrphanControl 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

Value — Control orphans and widows

true (default) | false | 1 | 0

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

Version History

Introduced in R2014b