mlreportgen.dom.Footnote Class

Namespace: mlreportgen.dom

Create an footnote in DOCX and PDF reports

Since R2024a

Description

Use an object of the mlreportgen.dom.Footnote class to include an footnote in a DOCX or PDF report.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

footnote = Footnote creates a default footnote object.

footnote = Footnote(text) creates a footnote object and appends its children with the Text object created using the specified string.

footnote = Footnote(double) creates a footnote object and appends its children with the Number object created using the specified double value.

footnote = Footnote(docElementObj) creates a footnote object and appends the DOM object to the its children using the specified DOM object.

endnote = Footnote(___,customMark) sets the CustomMark property to customMark, in addition to any combination of input arguments from previous syntaxes.

Input Arguments

text — Text object text

[] (default) | character vector | string scalar

Text used to create a Text object, specified as a character vector or string scalar.

Data Types: char | string

double — Number object value

[] (default) | numeric scalar

Value used to create a Number object, specified as a numeric scalar.

Data Types: double

docElementObj — Document element to include in footnote

[] (default) | DOM object

Document Object Model (DOM) object to include in the footnote, specified as one of these DOM objects:

• mlreportgen.dom.Paragraph

• mlreportgen.dom.Text

• mlreportgen.dom.Number

• mlreportgen.dom.Image

• mlreportgen.report.FormalImage

• mlreportgen.dom.Table

• mlreportgen.dom.FormalTable

• mlreportgen.dom.MATLABTable

• mlreportgen.dom.OrderedList

• mlreportgen.dom.UnorderedList

• mlreportgen.dom.ExternalLink

• mlreportgen.dom.InternalLink

• mlreportgen.dom.LinkTarget

Properties

CustomMark — Custom mark of this mlreportgen.dom.Footnote object

"" (default) | character vector | string scalar

Custom mark of this mlreportgen.dom.Footnote object, specified as a string scalar or a character vector. The mark must be a maximum of 10 characters long. If this property is empty, the mark of the first mlreportgen.dom.Footnote object is "1", incrementing for each additional mlreportgen.dom.Footnote object.

Example: "A"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StyleName — Style name of this mlreportgen.dom.Footnote object

[] (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

This style applies only to the footnote mark, not to the contents of the footnote.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification for footnote mark

{} (default) | array of format objects

Format specification for this footnote mark, specified as an array of 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 element are ignored.

Note

This style applies only to the footnote mark, not to the contents of the footnote.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of mlreportgen.dom.Footnote object

document element object

Parent of mlreportgen.dom.Footnote object, specified as a document element object. A document element object must have only one parent.

Note

You must append Footnote and Endnote objects to Paragraph objects.

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

Method	Purpose
append	Append content to this footnote obj = append(footnoteObj,"text") creates a Text object containing the specified text string and appends it to this footnote. obj = append(footnoteObj,number) creates a Number object containing the specified number and appends it to this footnote. obj = append(footnoteObj,obj) appends any of the following types of objects to this footnote: mlreportgen.dom.Paragraph mlreportgen.dom.Text mlreportgen.dom.Number mlreportgen.dom.Image mlreportgen.report.FormalImage mlreportgen.dom.Table mlreportgen.dom.FormalTable mlreportgen.dom.MATLABTable mlreportgen.dom.OrderedList mlreportgen.dom.UnorderedList mlreportgen.dom.ExternalLink mlreportgen.dom.InternalLink mlreportgen.dom.LinkTarget
clone	Create a copy of this DOM element clone = clone(elemObj) creates a copy of elemObj. Note Use this method to append the same content to different parts of a document. Do not attempt to add the same object to a document more than once.

Examples

Add Footnotes to Report

You can add footnotes to DOCX and PDF reports.

Import the DOM API package so you do not have to use fully qualified class names.

import mlreportgen.dom.*;

Create a document.

d = Document("report","docx");

Open the document and add a paragraph.

open(d);
para = Paragraph("When work began on the Parthenon");

Create a footnote, and append it to the paragraph.

footnote = Footnote("The temple of Athena Parthenos, completed in 438 B.C., regarded as finest Doric temple");
append(para,footnote);
append(para,", the Athenian empire was at the height of its power.");
append(d,para);

para = Paragraph("Second paragraph begins here");

Create a footnote, with a custom mark and append it to the paragraph.

footnote = Footnote("Second footnote text","A");
append(para,footnote);
append(para,", some more text.");
append(d,para);

Close and view the report.

close(d);
rptview(d);

Version History

Introduced in R2024a