mlreportgen.dom.LOC Class

Namespace: mlreportgen.dom

List of captions

Description

Use an object of the mlreportgen.dom.LOC class to generate a list of captioned report elements. To generate a list of figures with captions or tables with titles, use objects of the mlreportgen.dom.LOF and mlreportgen.dom.LOT classes, respectively. To generate a list for other types of report elements, such as equations, use an LOC object.

Each list item contains the caption of a report element and links to the caption in the report. In a PDF or Microsoft^® Word report, a list item also includes the page number and a leader that fills the space between the caption and page number.

In PDF and Word reports, the list of captions is placed at the location that you specified in the report generation program. In HTML reports, the list of captions is placed in a side panel and has a title that consists of List of followed by the value of the AutoNumberStreamName property with the first letter capitalized.

To include report elements in the list:

1. Choose a numbering stream name, for example, equation. Set the AutoNumberStreamName property of the LOC object to the numbering stream name.

2. Create captions or titles for the report elements using mlreportgen.dom.Paragraph objects.

3. Associate the Paragraph objects with the numbering stream name by using an mlreportgen.dom.AutoNumber object.

The way a list is generated depends on the report type.

• PDF — The DOM API generates the list during report generation.

• Word — The DOM API generates a placeholder for the list. To generate the list items, you must update the Word document in your report generation program or in Word. See Update Tables of Contents and Generated Lists in Word Documents.

• HTML — The DOM API generates a placeholder for the list. When the report opens in an HTML browser, the browser generates the list.

Note

You can use an LOC object for captions that follow a report element or titles that precede a report element.

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

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

LOCObj = mlreportgen.dom.LOC() creates an mlreportgen.dom.LOC object and sets the LeaderPattern property to ".".

LOCObj = mlreportgen.dom.LOC(leaderPattern) creates an mlreportgen.dom.LOC object and sets the LeaderPattern property to the specified leader pattern.

Properties

AutoNumberStreamName — Name of numbering stream

" " (default) | character vector | string scalar

Name of numbering stream, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LeaderPattern — Type of leader

"." (default) | "dots" | " " | "space"

Type of leader to use between the title and the page number, specified as one of these character vectors or string scalars:

• "." or "dots"

• " " or "space"

Note

This property applies only to PDF reports. Word reports always have a dots leader. HTML reports do not have a leader.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

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, seeTemplates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
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:

GetAccess	public
SetAccess	public
NonCopyable	true

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

clone

LOCObjCopy = clone(LOCObj) copies (clones) the specified LOC object. Use the clone method of an LOC object in the same way that you use the clone method of an mlreportgen.dom.Paragraph object.

Examples

Generate a List of Captions in a Report

This example generates a list of the captions for example code in a report. You can use the same procedure to generate a list of captions for other report elements. This example identifies the captions to include in the list by associating the captions with the automatic numbering stream that has the name example. You can use any name for the numbering stream as long as the name matches the value of the AutoNumberStream property of the mlreportgen.dom.LOC object that represents the list of captions.

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

import mlreportgen.dom.*

Create a report.

d = Document("DOM Report with List of Captions","pdf");

Create a list of captions placeholder and append it to the report.

locObj = LOC();
locObj.AutoNumberStreamName = "example";
append(d,locObj);
append(d,PageBreak);

Create a paragraph that includes example code.

pr1 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");
append(d,pr1);

Create a paragraph for the example code caption.

p1 = Paragraph("Example ");

Create an automatic numbering stream with the name example and associate it with the paragraph.

append(p1,AutoNumber("example"));

Increment the counter for the numbering stream.

p1.Style = {CounterInc("example"),WhiteSpace("preserve")};

Append the rest of the caption text to the paragraph and append the paragraph to the report.

append(p1,".");
append(p1," Addition");
append(d,p1);

Create another paragraph that contains example code and a caption for the example code. Associate the example numbering stream with the caption and increment the numbering counter.

pr2 = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a * b;");
append(d,pr2);
p2 = Paragraph("Example ");
append(p2,AutoNumber("example"));
p2.Style = {CounterInc("example"),WhiteSpace("preserve")};

Append the rest of the caption text to the paragraph and append the paragraph to the report.

append(p2,".");
append(p2," Multiplication");
append(d,p2);

Close and view the report.

close(d);
rptview(d);

Here is the list of captions in the generated report:

Version History

Introduced in R2020b