mlreportgen.dom.WidowOrphanControl class

Package: 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 — ID for this document element

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag for this document element

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
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