mlreportgen.dom.KeepWithNext class

Package: mlreportgen.dom

Keep document element on same page as next

Description

Use objects of the mlreportgen.dom.KeepWithNext class to keep a document element on the same page as the document element that follows it. This format applies to Microsoft^® Word and PDF documents.

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

Creation

Description

obj = KeepWithNext() keeps the document element on the same page as the document element that follows it. The document element must be a paragraph, table row, or list item.

obj = KeepWithNext(onOff) sets the Value property to onOff.

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

Strength — Strength that paragraphs stay together

1 (default) | "always" | integer

Strength that the document elements stay together on the same page, specified as "always" or an integer. When you specify the property as "always", the DOM object always keeps the document elements together on the same page. When you specify the property as a positive integer, the size of the integer dictates the strength that the document elements stay together. The greater the integer, the less likely the document elements appear on separate pages.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | 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 — Whether to keep document element on same page

true or 1 | false or 0

Whether to keep the document element on the same page as the following document element, specified as a numeric or logical 1 (true) or 0 (false). When this property is true, the object keeps the document elements on the same page according to the value of the Strength property.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Version History

Introduced in R2014b