mlreportgen.dom.LOC 类
命名空间: mlreportgen.dom
标题列表
描述
使用 mlreportgen.dom.LOC 类的对象生成带题注的报告元素列表。要生成带有题注的图窗列表或带有标题的表，请分别使用 mlreportgen.dom.LOF 和 mlreportgen.dom.LOT 类的对象。要生成其他类型的报告元素（例如方程）的列表，请使用 LOC 对象。
每个列表项包含报告元素的题注和指向报告中题注的链接。在 PDF 或 Microsoft® Word 报告中，列表项还包括页码和填充题注与页码之间空白的引导符。
在 PDF 和 Word 报告中，题注列表位于您在报告生成程序中指定的位置。在 HTML 报告中，题注列表放在侧面板上，标题由 List of 和 AutoNumberStreamName 属性的值组成，首字母大写。
要将报告元素包含在列表中：
选择编号流名称，例如
equation。将LOC对象的AutoNumberStreamName属性设置为编号流名称。使用
mlreportgen.dom.Paragraph对象为报告元素创建题注或标题。使用
mlreportgen.dom.AutoNumber对象将Paragraph对象与编号流名称关联。
列表的生成方式取决于报告类型。
PDF - DOM API 在报告生成期间生成列表。
Word - DOM API 为列表生成一个占位符。要生成列表项，您必须在报告生成程序或 Word 中更新 Word 文档。请参阅更新 Word 文档中的目录和生成的列表。
HTML - DOM API 为列表生成占位符。当报告在 HTML 浏览器中打开时，浏览器会生成列表。
注意
您可以使用 LOC 对象来表示报告元素下方的题注或报告元素上方的标题。
要了解可以将 mlreportgen.dom.LOC 对象追加到哪些 DOM 对象，请参阅将 mlreportgen.dom.LOC 对象追加到 DOM 类对象上。
mlreportgen.dom.LOC 类是一个 handle 类。
创建对象
描述
LOCObj = mlreportgen.dom.LOC()mlreportgen.dom.LOC 对象并将 LeaderPattern 属性设置为 "."。
LOCObj = mlreportgen.dom.LOC(leaderPattern)mlreportgen.dom.LOC 对象，并将 LeaderPattern 属性设置为指定的引导符模式。
属性
方法
示例
此示例生成报告中示例代码的题注列表。您可以使用相同的过程来生成其他报告元素的题注列表。此示例通过将题注与名为 example 的自动编号流关联来标识要包含在列表中的题注。您可以对编号流使用任何名称，只要该名称与代表题注列表的 AutoNumberStream 对象的 mlreportgen.dom.LOC 属性值匹配即可。
导入 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 中推出
