Main Content

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

mlreportgen.dom.LOC 类

命名空间: mlreportgen.dom

题注列表

自 R2020b 起

全页展开

描述

使用 mlreportgen.dom.LOC 类的对象生成带题注的报告元素列表。要生成带有题注的图窗列表或带有标题的表格，请分别使用 mlreportgen.dom.LOF 和 mlreportgen.dom.LOT 类的对象。要生成其他类型的报告元素（例如方程）的列表，请使用 LOC 对象。

每个列表项包含报告元素的题注和指向报告中题注的链接。在 PDF 或 Microsoft® Word 报 告中，列表项还包括页码和填充题注与页码之间空白的引导符。

在 PDF 和 Word 报 告中，题注列表位于您在报告生成程序中指定的位置。在 HTML 报 告中，题注列表放在侧面板上，标题由 List of 和 AutoNumberStreamName 属性的值组成，首字母大写。

要将报告元素包含在列表中：

  1. 选择编号流名称，例如 equation。将 LOC 对象的 AutoNumberStreamName 属性设置为编号流名称。

  2. 使用 mlreportgen.dom.Paragraph 对象为报告元素创建题注或标题。

  3. 使用 mlreportgen.dom.AutoNumber 对象将 Paragraph 对象与编号流名称关联。

列表的生成方式取决于报告类型。

  • PDF - DOM API 在报告生成期间生成列表。

  • Word - DOM API 为列表生成一个占位符。要生成列表项，您必须在报告生成程序或 Word 中更新 Word 文档。请参阅更新 Word 文档中的目录和生成的列表。

  • HTML - DOM API 为列表生成占位符。当报告在 HTML 浏览器中打开时，浏览器会生成列表。

注意

您可以使用 LOC 对象来表示报告元素下方的题注或报告元素上方的标题。

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

类属性

ConstructOnLoad
true
HandleCompatible
true

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

创建对象

描述

示例

LOCObj = mlreportgen.dom.LOC() 创建一个 mlreportgen.dom.LOC 对象并将 LeaderPattern 属性设置为 '.'。

LOCObj = mlreportgen.dom.LOC(leaderPattern) 创建一个 mlreportgen.dom.LOC 对象，并将 LeaderPattern 属性设置为指定的引导符模式。

属性

全部展开

编号流的名称，指定为字符向量或字符串标量。

题注和页码之间使用的引导符类型，指定为以下字符向量或字符串标量之一：

  • '.' 或 'dots'

  • ' ' 或 'space'

此属性仅适用于 PDF 报 告。Word 报告总是以点为引导符。HTML 报 告没有引导符。

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

注意

Microsoft Word 输 出忽略样式名称。

属性：

NonCopyable
true

数据类型: char | string

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

属性：

NonCopyable
true

数据类型: cell

此文档元素的自定义属性，指定为 mlreportgen.dom.CustomAttribute 对象的数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性：

NonCopyable
true

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

属性：

SetAccess
private
NonCopyable
true

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

属性：

SetAccess
private
NonCopyable
true

mlreportgen.dom.LOC 对象的标签，指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。指定您自己的标签值，以帮助您确定在文档生成过程中出现问题时要查找的位置。

属性：

NonCopyable
true

数据类型: char | string

mlreportgen.dom.LOC 对象的对象标识符，指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

打开实时脚本

此示例生成报告中示例代码的题注列表。您可以使用相同的过程来生成其他报告元素的题注列表。此示例通过将题注与名为 example 的自动编号流关联来标识要包含在列表中的题注。您可以对编号流使用任何名称，只要该名称与代表题注列表的 mlreportgen.dom.LOC 对象的 AutoNumberStream 属性值匹配即可。

导入 DOM API 命名空间，这样您就不必使用长而完全限定的类名。

import mlreportgen.dom.*

创建报告。

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

创建题注列表占位符并将其追加到报告中。

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

创建一个包含示例代码的段落。

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

为示例代码题注创建一个段落。

p1 = Paragraph("Example ");

创建一个名为 example 的自动编号流并将其与段落关联。

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

增加编号流的计数器。

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

将其余题注文本追加到段落并将段落追加到报告中。

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

创建另一个包含示例代码和示例代码题注的段落。将示例编号流与题注关联，并增加编号计数器。 

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(p2,".");
append(p2," Multiplication");
append(d,p2);

关闭并查看报告。

close(d);
rptview(d);

以下是生成的报告中的题注列表：

版本历史记录

在 R2020b 中推出

另请参阅

| | | | | |

主题