mlreportgen.report.TableOfContents类

包:mlreportgen.report
超类:mlreportgen.report.Reporter

目录报告人

展开全部页面

描述

创建一个目录(TOC)报告器，该报告器将一个目录添加到报告中。该类继承自mlreportgen.report.Reporter．

的mlreportgen.report.TableOfContents类是一个处理类。

创建

描述

toc= TableOfContents ()返回一个为报告生成目录(TOC)部分的报告器。TOC部分的默认模板定义了TOC的外观和页面布局。TOC部分包含一个默认标题和一个TOC元素，该元素指定要生成的TOC的位置，具体取决于报告输出类型。每种报告类型生成TOC的方式不同。

当报表在浏览器中打开时，从报表模板复制到报表的HTML - JavaScript将生成TOC。脚本将TOC生成为可折叠树。树条目是报告的HTML标题元素(h1-h6)的超链接内容。TOC树中条目的级别对应于标题元素的级别。章节和节报告器生成章节和节标题作为相应级别的标题元素，因此章节和节标题自动出现在TOC中。您还可以在报表中使用DOM Heading元素来生成TOC条目。
DOCX -报表生成器rptview函数指示Word在Word中打开报表后生成TOC。如果您直接在Word中打开报告，而不使用rptview，你必须自行更新报告文件，以生成TOC。看到更新Word文档中的目录和生成列表．
TOC是一个两列表。第一列为已设置大纲级别的报告段落的超链接内容。大纲级别决定TOC条目的格式。第二列包含相应段落出现的页码。章节和节报告器将章节和节标题生成为具有适当级别设置的段落，因此章节和节标题自动出现在TOC中。您还可以在报表中使用DOM Heading元素来生成TOC条目。
PDF -目录在PDF文档生成过程中生成。

例子

toc= TableOfContents (标题）创建一个使用指定的TOC标题．

toc= TableOfContents (名称=值）使用名称-值对设置属性。您可以以任意顺序指定多个名称-值对参数。

属性

全部展开

`标题`- - - - - -目录标题
`目录`(默认)|字符串|字符数组|……

目录标题，指定为以下值之一:

字符串或字符数组
DOM对象
1 -N或N字符串或DOM对象的-by-1数组
1 -N或N字符串、字符数组和/或DOM对象的-by-1单元格数组
TableOfContentsTitle记者

例子:“TableOfContents”、“报告内容的

`NumberOfLevels`- - - - - -标题层数
3.(默认)|正整数

目录中要使用的标题级别数，指定为范围[1,9]中的正整数。

`LeaderPattern`- - - - - -领导类型
`“。”`(默认)|“点”|`＇＇`|“空间”

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

“。”或“点”
＇＇或“空间”

此属性仅适用于PDF报表。文字报告总是有一个点带头。HTML报告没有领导者。

`布局`- - - - - -目录部分的页面布局
`mlreportgen.report.ReporterLayout`对象

目录节的页面布局，指定为mlreportgen.report.ReporterLayout对象。属性的属性ReporterLayout对象重写某些默认页面布局属性，如页面方向。

`TemplateSrc`- - - - - -此报告的模板的来源
`［］`(默认)|特征向量|字符串标量|记者或报告|DOM文档或文档部分

此报告的模板源，指定为以下选项之一:

字符向量或字符串标量，指定包含此报表模板的文件的路径
报表或报表，其模板用于此报表，或其模板库包含此报表的模板
DOM文档或文档部分，其模板用于此报表，或其模板库包含此报表的模板

指定的模板必须与该报表附加到的报表类型相同。例如，对于a微软^®词报告,TemplateSrc必须是Word报表模板。如果TemplateSrc属性为空时，此报表将为报表的输出类型使用默认报表模板。

`TemplateName`- - - - - -该报表的模板名称
特征向量|字符串标量

此报表的模板名称，指定为字符向量或字符串标量。此报告的模板必须在模板源的模板库中(TemplateSrc)。

`LinkTarget`- - - - - -这个记者的超链接目标
`［］`(默认)|特征向量|字符串标量|`mlreportgen.dom.LinkTarget`对象

的超链接目标，指定为字符向量或指定链接目标ID的字符串标量，或指定为mlreportgen.dom.LinkTarget对象。字符向量或字符串标量值转换为LinkTarget对象。在输出报告中，链接目标紧跟在此报告器的内容之前。

方法

全部展开

公共方法

`mlreportgen.report.TableOfContents.createTemplate`	创建目录节模板
`mlreportgen.report.TableOfContents.customizeReporter`	创建自定义目录报表类
`mlreportgen.report.TableOfContents.getClassFolder`	目录类定义文件位置
`getTitleReporter`	获得目录标题记者
`复制`	创建报告对象的副本，并对某些属性值进行深度复制
`getImpl`	获取报告者的实现

例子

全部折叠

默认目录

创建一个使用默认格式的目录。

进口mlreportgen.report。*rpt =报告(“输出”，“pdf”）;toc = TableOfContents();add (rpt, toc);

定制目录

创建一个报告，其中包含一个标题为绿色的目录表。本报告还包括章节、章节和附录部分。

进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“与TOC一起报告”）;添加(rpt, TitlePage(标题=“报告”字幕=“与TOC”));toc = TableOfContents;toc。标题=文本(“目录”）;toc.Title.Color =“绿色”；toc。NumberOfLevels = 2; add(rpt,toc); ch = Chapter(“第一章”）;添加(ch,部分(“第一节”));添加(ch,部分(第二小节的));add (rpt, ch);add (rpt,章(“第二章”));add (rpt, PDFPageLayout);p =段落(“附录”）;p.Style = {OutlineLevel(1)， Bold, FontSize(“18 pt”)};添加(rpt, p);关闭(rpt);rptview (rpt);