mlreportgen.report.Chapterclass

包:mlreportgen.report
超类:mlreportgen.report.Section

记者章

扩展所有的页面

描述

使用的对象mlreportgen.report.Chapter类来添加一个章的报告。

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

类属性

HandleCompatible 真正的

类属性的信息,请参阅类属性。

创建

描述

ch= mlreportgen.report.Chapter ()创建一个记者,生成一个章。这一章有一个新的页面布局定义的默认模板的记者。

默认的模板是一个肖像页面页眉和页脚。头是空的。如果一个报告的第一章,章页脚包含一个自动生成的页面数量从1开始。如果不是第一章,章页码继续前一章的最后一页。使用布局属性覆盖一章的页面布局的一些特性,比如取向。

使用标题属性指定标题。

添加内容到章,使用附加的方法mlreportgen.report.Chapter对象。

请注意

在你报告添加一章之前,将所有的内容添加到章节。一旦你添加一份报告这一章,你不能添加更多的这一章的内容。

例子

ch= mlreportgen.report.Chapter (标题)创建一个与指定的章标题。看到标题财产。

ch= mlreportgen.report.Chapter (名称,值)使用名称-值对集合属性。你可以在任何顺序指定多个参数名称-值对。附上每个属性名称在单引号或双引号。

属性

全部展开

`标题`- - - - - -章标题
字符串标量|特征向量|DOM对象|……

章标题,指定这些值之一:

字符串标量或特征向量
DOM对象
1 -N或N1字符串标量或DOM对象的数组
1 -N或N1单元阵列的字符串标量,特征向量,和/或DOM对象
SectionTitle记者返回的getTitleReporter方法

标题出现在这一章的开始,所有章的标题页除了第一页。标题也出现在报告的目录。

内联对象是一段可以包含的对象。如果标题值是内联对象章对象使用一个模板的模板库来创建一个标题基于价值。模板用于创建标题取决于标题编号。一章的标题是默认编号。关掉这一章编号,使用编号财产。关掉所有报告中其他章节编号,使用mlreportgen.report.Section.number方法。

如果标题编号,标题是由一个字符串前缀英文报告表单的一章N,在那里N章是自动生成的数字。在其他一些地区,英语前缀是语言环境的语言翻译。看到语言环境的属性mlreportgen.report.Report的翻译的地方。

您可以使用内联DOM对象覆盖指定的字符格式默认章标题模板。

如果标题值是一个DOM段落或其它DOM块对象,这一章插入对象在这一章的开始。如果你使用DOM对象,您可以使用块元素定制间距,对齐,和其他属性的章标题。在这种情况下,您必须完全指定标题格式和提供标题编号。

请注意

正确显示为页面标题标题标题的样式名SectionTitle1。如果被指定为一个DOMmlreportgen.dom.Paragraph对象没有StyleName属性设置,StyleName属性属性自动更改为正确的样式名。您可以自定义段落样式的风格包括DOM对象风格财产的段对象。如果你使用一个自定义的模板格式标题,确保所使用的模板的样式名称SectionTitle1。自定义标题样式的修改SectionTitle1风格自定义模板。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

`编号`- - - - - -是否这一章
`真正的`|`假`

是否数量这一章,指定为真正的或假。如果该值的编号为空或真正的,这一章是在报告中相对于其他章节编号。章号出现在标题。如果该值的编号是假,本章不编号。的值编号属性将覆盖所有章节的报告指定的编号mlreportgen.report.Chapter.number方法。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

`内容`- - - - - -本节的内容
字符串标量|特征向量|内联对象|……

部分的内容,指定这些值之一:

字符串标量或特征向量
DOM对象,可以添加到一个DOM文档部分
记者,包括部分记者
1 xN或Nx1的数组字符串标量或特征向量
1 xN或Nx1单元阵列的字符串标量,特征向量,和/或DOM对象

使用章构造函数或附加方法来设置该属性。你不能直接把它。

属性:

`GetAccess`	`公共`
`SetAccess`	`限制访问`

`布局`- - - - - -本章布局
`mlreportgen.report.ReporterLayout`

本章布局外,作为一个指定mlreportgen.report.ReporterLayout对象。使用的属性ReporterLayout对象覆盖的一些章节布局属性中定义的模板的章。

例子:chapter.Layout。景观= true

属性:

`GetAccess`	`公共`
`SetAccess`	`限制访问`

`TemplateSrc`- - - - - -这个记者的模板
`[]`(默认)|特征向量|字符串标量|记者或报告|DOM文档或文档部分

这个记者的模板,指定其中的一个方面:

特征向量或字符串标量指定路径的文件,其中包含的模板的记者
记者或报告的模板是用于这个记者或模板库中包含的模板的记者
DOM文档或文档模板的一部分用于记者或模板库中包含的模板的记者

指定的模板必须是相同的类型作为这个记者是附加的报告。例如,对于一个微软^®词报告,TemplateSrc必须是一个文字记者模板。如果TemplateSrc属性是空的,这个记者记者使用默认模板输出类型的报告。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

`TemplateName`- - - - - -这个记者名字的模板
特征向量|字符串标量

这个记者,模板的名称指定为一个特征向量或字符串标量。这个记者的模板必须在指定的模板的模板库TemplateSrc这个记者的属性。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

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

这个记者,超链接目标指定为一个特征向量或指定链接目标ID字符串标量,或一个mlreportgen.dom.LinkTarget对象。一个特征向量或字符串转换为一个标量值LinkTarget对象。链接目标立即先于这个记者在输出中报告的内容。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

方法

全部展开

公共方法

`附加`	添加内容章
`添加`	(不推荐)添加内容章节
`getTitleReporter`	章标题的记者
`mlreportgen.report.Chapter.number`	`mlreportgen.report.Chapter.number(报告编号)`指定是否要数章在一份报告中称。如果`编号`是`真正的`在报告中,所有的章节已经屈指可数了。
`mlreportgen.report.Chapter.createTemplate`	`mlreportgen.report.Chapter.createTemplate (templatePath类型)`创建一个副本`章`指定的模板`类型`在指定的位置`templatePath`。您可以使用这个方法来创建一个复制违约部分模板作为一个起点为创建自己的自定义模板。
`mlreportgen.report.Chapter.customizeReporter`	`mlreportgen.report.Chapter.customizeReporter (toClasspath)`创建一个空类派生的`章`记者类的名称`toClasspath`。您可以使用生成的类作为起点来创建一个定制版本的`章`记者。
`mlreportgen.report.Chapter.getClassFolder`	`mlreportgen.report.Chapter.getClassFolder ()`返回的路径包含的类定义文件的文件夹`章`记者类。
`复制`	创建的副本记者对象,使深拷贝的属性值,引用一个记者,ReporterLayout或DOM对象
`getImpl`	DOM实现这个记者

例子

全部折叠

向报告添加一个章

打开生活的脚本

添加一个部分的一章,这一章的报告。一章的布局方向设置为景观。

进口mlreportgen.report。*进口mlreportgen.dom。*rpt =报告(“我的报告”,“pdf”);追加(rpt TitlePage (“标题”,“我的报告”));章=章(“图片”);chapter.Layout。景观= true;追加(章、节(“标题”,“波音747”,…“内容”、图像(“b747.jpg”)));追加(rpt,章);关闭(rpt);rptview (rpt);

这是第一章的第一页在生成的报告。

兼容性的考虑

全部展开

`添加`方法是不可取的

不推荐在R2020b开始

从R2020b,使用附加方法,而不是添加方法将内容添加到这些报告API类的对象:

mlreportgen.report.Report
mlreportgen.report.Chapter
mlreportgen.report.Section

将内容添加到一个DOM API对象,比如一个mlreportgen.dom.Paragraph对象,继续使用附加DOM对象的方法。使用的优势附加将内容添加到报告API对象是你使用相同的方法名使用DOM API将内容添加到对象。

没有删除的计划添加的方法报告,章,或部分类。报告API使用的程序添加方法将继续运行。

更新现有的代码,替换方法名添加与附加由表中的示例所示。

不推荐	推荐
进口mlreportgen.report。进口mlreportgen.dom。rpt =报告(“我的报告”,“pdf”);ch =章(“我的章”);教派=节(“我的部分”);帕拉=段(“我的内容”);追加(帕拉,“更多内容”);添加(教派,para);添加(ch,教派);add (rpt, ch);关闭(rpt);rptview (rpt);	进口mlreportgen.report。进口mlreportgen.dom。rpt =报告(“我的报告”,“pdf”);ch =章(“我的章”);教派=节(“我的部分”);帕拉=段(“我的内容”);追加(帕拉,“更多内容”);追加(教派,para);追加(ch,教派);追加(rpt, ch);关闭(rpt);rptview (rpt);

不推荐

另请参阅

mlreportgen.report.Section|mlreportgen.report.Report|mlreportgen.report.Reporter|mlreportgen.report.ReportLayout

主题

一个记者是什么?

介绍了R2017b

mlreportgen.report.Chapterclass

描述

类属性

创建

描述