本页采用了机器翻译。点击此处可查看英文原文。

mlreportgen.dom.Footnote 类

命名空间: mlreportgen.dom

在 DOCX 和 PDF 报告中创建脚注

自 R2024a 起

全页展开

描述

使用 mlreportgen.dom.Footnote 类的对象在 DOCX 或 PDF 报告中包含脚注。

要了解可以将 mlreportgen.dom.Footnote 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.Footnote 对象追加到 DOM 类对象上。

此类仅与以下 MATLAB® Report Generator™ 输出类型兼容：

  • "docx"

  • "pdf"

  • "pdfa" (自 R2025a 起)

mlreportgen.dom.Footnote 类是一个 handle 类。

类属性

HandleCompatible
true

有关类属性的信息，请参阅类属性。

创建对象

描述

footnote = Footnote 创建一个默认的脚注对象。

footnote = Footnote(text) 创建一个脚注对象并将其子对象追加到使用指定字符串创建的 Text 对象中。

示例

footnote = Footnote(double) 创建一个脚注对象并将其子对象追加到使用指定双精度值创建的 Number 对象中。

footnote = Footnote(domObj) 创建一个脚注对象并使用指定的 DOM 对象将 DOM 对象追加到其子对象。

除了前面语法中的任意输入参量组合之外，endnote = Footnote(___,customMark) 还将 CustomMark 属性设置为 customMark。

输入参量

全部展开

用于创建 Text 对象的文本，指定为字符向量或字符串标量。

数据类型: char | string

用于创建 Number 对象的值，指定为数字标量。

数据类型: double

属性

全部展开

此 mlreportgen.dom.Footnote 对象的自定义标记，指定为字符串标量或字符向量。标记的最大长度不得超过 10 个字符。如果该属性为空，则第一个 mlreportgen.dom.Footnote 对象的标记为 "1"，每增加一个 mlreportgen.dom.Footnote 对象，标记就会递增。

示例: "A"

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了此元素在输出文档中的外观，除非由此元素的 Style 属性指定的格式覆盖。要了解有关使用样式表的更多信息，请参阅 使用样式表样式。

注意

此样式仅适用于脚注标记，不适用于脚注的内容。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此脚注标记的格式规范，指定为格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此元素的格式将被忽略。

注意

此样式仅适用于脚注标记，不适用于脚注的内容。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

mlreportgen.dom.Footnote 对象的父级，指定为文档元素对象。一个文档元素对象必须只有一个父对象。

注意

您必须将 Footnote 和 Endnote 对象追加到 Paragraph 对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象，指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性：

GetAccess
public
SetAccess
private
NonCopyable
true

标记，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开实时脚本

您可以向 DOCX 和 PDF 报告添加脚注。

导入 DOM API 包，这样您就不必使用完全限定的类名。

import mlreportgen.dom.*;

创建文档。

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

打开文档并添加一个段落。

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

创建脚注，并将其追加到段落。

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");

创建脚注，带有自定义标记并将其追加到段落。

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

关闭并查看报告。

close(d);
rptview(d);

详细信息

全部展开

版本历史记录

在 R2024a 中推出

另请参阅

| |