mlreportgen.dom.Endnote Class

Namespace: mlreportgen.dom

Create endnote in DOCX or PDF report

Since R2024a

Description

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

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

endnote = Endnote creates a default endnote object.

endnote = Endnote(text) creates an endnote object, and appends its children with the Text object created using the specified string.

endnote = Endnote(double) creates an endnote object, and appends its children with the Number object created using the specified double value.

endnote = Endnote(docElementObj) creates an endnote object, and appends the specified DOM object to its children.

endnote = Endnote(___,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 endnote

[] (default) | DOM object

Document Object Model (DOM) object to include in the endnote, 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.Endnote object

"" (default) | character vector | string scalar

Custom mark of this mlreportgen.dom.Endnote 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.Endnote object is "1", incrementing for each additional mlreportgen.dom.Endnote object.

Example: "A"

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StyleName — Style name of this mlreportgen.dom.Endnote 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 you append this object. The specified style defines the appearance of this object 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 endnote mark, not to the contents of the endnote.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification for endnote mark

{} (default) | array of format objects

Format specification for this endnote mark, specified as an array of format objects. The formats specified by this property override corresponding formats specified by the StyleName property. The endnote ignores formats that do not apply to this document element object.

Note

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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of mlreportgen.dom.Endnote object

document element object

Parent of mlreportgen.dom.Endnote 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 endnote obj = append(endnoteObj,text) creates a Text object containing the specified character vector or sting scalar text and appends it to this endnote. obj = append(endnoteObj,number) creates a Number object containing the specified number and appends it to this endnote. obj = append(endnoteObj,obj) appends any of these types of objects to this endnote: 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 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 Endnotes to Report

You can add endnotes 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 an endnote, and append it to the paragraph.

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

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

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

endnote = Endnote("Second endnote text","A");
append(para,endnote);
append(para,", some more text.");
append(d,para);

Close and view the report.

close(d);
rptview(d);

Version History

Introduced in R2024a