mlreportgen.dom.LineBreak Class

Namespace: mlreportgen.dom

Line break in a Word or PDF report

expand all in page

Description

Use an object of the mlreportgen.dom.LineBreak class to insert a line break anywhere in a Microsoft® Word or PDF report.

To see what DOM objects you can append an mlreportgen.dom.LineBreak object to, see Append mlreportgen.dom.LineBreak 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.LineBreak class is a handle class.

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

For information on class attributes, see Class Attributes.

Creation

Description

lBreak = mlreportgen.dom.LineBreak creates a line break object.

example

Properties

expand all

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

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

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 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 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, 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

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

expand all

Examples

collapse all

Open Live Script

This example shows how to insert a line break in a PDF report by using a LineBreak object.

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

import mlreportgen.dom.*;

Create a Document object and open it.

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

Create the first page and add a heading to the object. Create a Paragraph object p.

h = Heading1("Learning to Use Line Breaks");
append(d,h);
p = Paragraph("Use a LineBreak object");

Specify preserve for the WhiteSpace method for the Paragraph object to add a line break to it. Append the LineBreak handle class to the paragraph.

p.WhiteSpace = 'preserve';
append(p,LineBreak);

Insert the next line by appending it to the existing Paragraph object. Append the paragraph to the Document. 

append(p,"to force a new line in a paragraph");
append(d,p);

Close and view the document.

close(d);
rptview(d);

More About

expand all

Version History

Introduced in R2016b

See Also

| | | |

Topics