Main Content

mlreportgen.dom.PageBreak Class

Namespace: mlreportgen.dom

Page break in a Word or PDF report

Description

Use mlreportgen.dom.PageBreak to insert a page break anywhere in a Microsoft® Word or PDF report.

Tip

Use an mlreportgen.dom.PageBreakBefore object to force a page break before a specific paragraph. For example, use PageBreakBefore to force chapters to start on a new page.

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

Creation

Description

example

break = mlreportgen.dom.PageBreak creates a page break object.

Properties

expand all

Style name, specified as a character vector or a string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless overridden by the formats specified by the Style property of this element. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word output ignores the style name.

Attributes:

NonCopyable
true

Data Types: char | string

Format specification for this document element object, specified as an array of format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this element are ignored.

Attributes:

NonCopyable
true

Data Types: cell

Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format of the document element to which this object is appended.

Attributes:

NonCopyable
true

Parent of mlreportgen.dom.PageBreak object, specified as a document element object. A document element must have only one parent.

Attributes:

SetAccess
private
NonCopyable
true

Children of mlreportgen.dom.PageBreak object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

SetAccess
private
NonCopyable
true

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

Object identifier for mlreportgen.dom.PageBreak 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

Methods

expand all

Examples

collapse all

This example shows how to insert a page break in a PDF report by using a PageBreak object.

Import the DOM API namespace so that you do not have to use long, fully qualified names.

import mlreportgen.dom.*;

Create a Document object and open it.

d = Document("mydoc","pdf");
open(d);

Create the first page consisting of a heading and some paragraphs.

h = Heading1("My First Heading");
append(d,h);
p = Paragraph("Here are some paragraphs.");
append(d,p);
for i = 1:5
append(d,clone(p));
end

Insert a page break by using a PageBreak object.

br = PageBreak();
append(d,br);

In the newly created second page, append some paragraphs.

p2 = Paragraph("Here are some paragraphs after the forced page break.");
append(d,p2);
for i = 1:5
append(d,clone(p2));
end

Close and view the document.

close(d);
rptview(d);

Version History

Introduced in R2016a