Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

mlreportgen.dom.KeepWithNext class

Package: mlreportgen.dom
Superclasses:

Keep paragraph on same page as next

Description

Keep paragraph on same page as the paragraph that follows it. This format applies to Microsoft® Word and PDF documents.

Construction

obj = KeepWithNext() keeps a paragraph on the same page as the paragraph that follows it.

obj = KeepWithNext(onoff) keeps a paragraph on the same page as the paragraph that follows it if onoff is true.

Input Arguments

expand all

Use one of these values:

  • true (default)

  • false

  • 1

  • 0

A setting of true (or 1) keeps a paragraph on the same page as the paragraph that follows it. A setting of false (or 0) allows a paragraph to be on a different page from the paragraph that follows it.

Data Types: logical

Output Arguments

expand all

Keep paragraph on same page as next, represented by an mlreportgen.dom.keepWithNext object.

Properties

expand all

ID for this document element, specified as a character vector. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

Use one of these values:

  • true or 1 — Keeps a paragraph on the same page as the paragraph that follows it.

  • false or 0 — Allows a paragraph to be on a different page from the paragraph that follows it.

Data Types: logical

Was this topic helpful?