mlreportgen.dom.Leader Class
Namespace: mlreportgen.dom
Leader character for PDF output
Description
Create a leader character for PDF documents. A leader is a repeated character that fills out the available space in text.
The mlreportgen.dom.Leader
class is a handle
class.
Creation
Description
Input Arguments
Type of leader to use, specified as:
"."
or"dots"
for a dot leader" "
(space character) or"space"
for a space
Properties
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 |
Type of leader to use, specified as:
"."
or"dots"
for a dot leader" "
(space character) or"space"
for a space
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:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
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, seeTemplates for DOM API Report Programs.
Attributes:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Data Types: char
| string
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
Method | Purpose |
---|---|
Copy this object. |
Examples
This example uses a dot leader and a space leader in a PDF report.
import mlreportgen.dom.*; d = Document('mydoc','pdf'); open(d); h = Heading1('Cast'); h.HAlign = 'center'; % Create a leader object l using a space as the leader type % Append the leader object to a Heading2 paragraph l = Leader(' '); h2 = Heading2('Role'); append(h2,l); append(h2,'Actor'); append(d,h); append(d,h2); % Create a leader object dotl using the default leader type of a dot % Define variables for the content dotl = Leader(); role = 'Romeo'; actor = 'Leonardo DiCaprio'; % Append the variable text and leader object to a paragraph p = Paragraph(); append(p,role); append(p,dotl); append(p,actor); append(d,p); % Repeat, updating variables for each new paragraph % Insert a clone of the dotl object role = 'Juliet'; actor = 'Claire Danes'; p = Paragraph(); append(p,role); append(p,clone(dotl)); append(p,actor); append(d,p); role = 'Tybalt'; actor = 'John Leguizamo'; p = Paragraph(); append(p,role); append(p,clone(dotl)); append(p,actor); append(d,p); close(d); rptview(d.OutputPath);
Version History
Introduced in R2016a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
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)