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

mlreportgen.dom.FootnoteOptions 类

命名空间: mlreportgen.dom

指定 DOCX 或 PDF 文档或文档部分的脚注选项

自 R2024a 起

全页展开

描述

文档对象模型 (DOM) API 使用 mlreportgen.dom.FootnoteOptions 类作为文档和页面布局对象的 FootnoteOptions 属性的默认值。设置这些 mlreportgen.dom.FootnoteOptions 对象的属性来指定文档和文档页面布局部分的脚注选项。您不需要自己创建此类的实例。如果为节和包含该节的文档都指定了 FootnoteOptions 属性，则该节的 FootnoteOptions 属性将优先。如果 mlreportgen.dom.FootnoteOptions 的任何属性为空，则文档使用默认值。

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

类属性

HandleCompatible
true

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

属性

全部展开

脚注标记编号类型，指定为以下有效编号类型之一：

  • "decimal"（默认值）

  • "upperRoman"

  • "lowerRoman"

  • "upperLetter"

  • "lowerLetter"

  • "chicago"

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

脚注标记编号的起始值，指定为正整数。如果指定的值包含小数，则类将值向下舍入到最接近的整数。

如果将 NumberingRestart 属性设置为 "eachSect" 或 "eachPage"，并在 DOCX 文档中使用此类，则无论此属性的值如何，编号都会在每个部分或页面的开头重新从 1 开始。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: double

重新开始脚注编号的位置，指定为以下选项之一：

  • "continuous"（默认）--脚注编号循环继续，不会重新开始。

  • "eachSect"- 脚注编号在文档的每个新部分开始处重新开始。

  • "eachPage"- 脚注编号从文档新页的开头重新开始。您只能将 NumberingRestart 设置为此值用于 DOCX 文档。

如果将此属性设置为 "eachSect" 或 "eachPage"，并在 DOCX 文档中使用此类，则无论 NumeringStartValue 属性的值如何，编号都会在每个部分或页面的开头重新从 1 开始。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

脚注的位置，指定为 "pageBottom" 或 "beneathText"。该位置可以是页面底部，"pageBottom"，也可以是页面文本末尾，"beneathText"（仅限 DOCX）。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

标记，指定为字符向量或字符串标量。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");

设置文档范围的脚注选项。

d.FootnoteOptions.NumberingType = "lowerRoman";
d.FootnoteOptions.NumberingStartValue = 2;

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

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");
append(para,footnote);
append(para,", some more text.");
append(d,para);

关闭并查看报告。

close(d);
rptview(d);

版本历史记录

在 R2024a 中推出

另请参阅

| | |