mlreportgen.dom.PageBreak Class

Namespace: mlreportgen.dom

Page break in a Word or PDF report

Description

Use an object of the mlreportgen.dom.PageBreak class 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.

To see what DOM objects you can append an mlreportgen.dom.PageBreak object to, see Append mlreportgen.dom.PageBreak object to DOM class object.

This class is only compatible with these MATLAB^® Report Generator™ output types:

• "docx"

• "pdf"

• "pdfa" (since R2025a)

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

Class Attributes

HandleCompatible	true
ConstructOnLoad	true

Creation

Description

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

Properties

StyleName — Name of stylesheet-defined style

[] (default) | character vector | string scalar

Name of stylesheet-defined style, specified as a character vector or 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 the formats specified by the Style property of this element override it. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft Word reports ignore style names that are not defined in the document template. For more information on Microsoft Word templates, see Templates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | cell array of DOM format objects

Format specification for this document element object, specified as a cell array of DOM 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 document element object are ignored.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

Custom attributes of the 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:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of this object

document element object

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

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — Children of this object

array of document element objects

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

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

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

Methods

Public Methods

Method

Purpose

clone

copiedObj = clone(soureceObj) returns a copy of the mlreportgen.dom.PageBreak object specified by soureceObj. The copy includes the children of the source object, but not the parent. Note Do not append the same object to a document more than once. Use clone to create a copy when you want to reuse the same content elsewhere in a document. Input Arguments soureceObj — Object to clone, specified as an mlreportgen.dom.PageBreak object Return Values copiedObj— Object copy, returned as an mlreportgen.dom.PageBreak object For more information, see the equivalent method for the mlreportgen.dom.Paragraph class, clone.

Examples

Insert a Page Break

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);

More About

Append mlreportgen.dom.PageBreak object to DOM class object

You can append an mlreportgen.dom.PageBreak object to these DOM class objects:

• mlreportgen.dom.Container

• mlreportgen.dom.CustomElement

• mlreportgen.dom.Document

• mlreportgen.dom.DocumentPart

• mlreportgen.dom.DOCXPageFooter

• mlreportgen.dom.DOCXPageHeader

• mlreportgen.dom.Group

• mlreportgen.dom.PDFPageFooter

• mlreportgen.dom.PDFPageHeader

• mlreportgen.dom.Template

• mlreportgen.dom.TemplateDocumentPart (since R2023b)

Version History

Introduced in R2016a