mlreportgen.dom.LineBreak Class
Namespace: mlreportgen.dom
Line break in a Word or PDF report
Description
Use an object of mlreportgen.dom.LineBreak
to insert a line break
anywhere in a Microsoft® Word or PDF report.
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
creates a line break object.lBreak
= mlreportgen.dom.LineBreak
Properties
StyleName
— Name of stylesheet-defined style
[]
(default) | character vector | string scalar
Style name, 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 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
Style
— Format specification
{}
(default) | array of DOM format objects
Format specification for this document element object, specified as an 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:
NonCopyable | true |
CustomAttributes
— Custom attributes of document element
[]
(default) | array of mlreportgen.dom.CustomAttribute
objects
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
— Parent of mlreportgen.dom.LineBreak
object
document element object
Parent of mlreportgen.dom.LineBreak
object, specified as a document element
object. A document element must have only one parent.
Attributes:
SetAccess | private |
NonCopyable | true |
Children
— Children of mlreportgen.dom.LineBreak
object
array of document element objects
Children of mlreportgen.dom.LineBreak
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
— Tag for mlreportgen.dom.LineBreak
object
character vector | string scalar
Tag for the mlreportgen.dom.LineBreak
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
Id
— Object identifier for mlreportgen.dom.LineBreak
object
character vector | string scalar
Object identifier for the mlreportgen.dom.LineBreak
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
Examples
Insert a Line Break
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);
Version History
Introduced in R2016b
Commande MATLAB
Vous avez cliqué sur un lien qui correspond à cette commande MATLAB :
Pour exécuter la commande, saisissez-la dans la fenêtre de commande de MATLAB. Les navigateurs web ne supportent pas les commandes MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)