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

lead = Leader creates a leader object using a dot leader.

lead = Leader(pattern) uses the specified leader type.

Input Arguments

pattern — Type of leader to use

'.' (default) | ' ' (space) | 'dots' | 'space'

Type of leader to use, specified as:

• '.' or 'dots' for a dot leader

• ' ' (space character) or 'space' for a space

Properties

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

Pattern — Type of leader to use

'.' (default) | ' ' (space) | 'dots' | 'space'

Type of leader to use, specified as:

• '.' or 'dots' for a dot leader

• ' ' (space character) or 'space' for a space

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

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

Parent — Parent of mlreportgen.dom.Leader object

document element object

Parent of mlreportgen.dom.Leader 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.Leader object

array of document element objects

Children of mlreportgen.dom.Leader 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.Leader object

character vector | string scalar

Tag for the mlreportgen.dom.Leader 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.Leader object

character vector | string scalar

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

Public Methods

Method	Purpose
clone	Copy this object.

Examples

Insert Leaders in a PDF Report

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