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.

This class is only compatible with this MATLAB^® Report Generator™ output type: "docx".

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

1 (true) (default) | 0 (false)

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

Properties

Value — Control orphans and widows

1 (true) (default) | 0 (false)

Control orphans and widows, specified as a logical 1 (true) or 0 (false). When you specify:.

• 1 (true) — Prevents a page break after the first line of a paragraph (orphan) or before the last line of a paragraph (widow).

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Tag — Tag

character vector | string scalar

Tag, 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Version History

Introduced in R2014b