mlreportgen.report.RptFileclass

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

创建报告Explorer-based记者

自从R2019a

扩展所有的页面

描述

使用RptFile记者Explorer设置(包括生成的内容报告.rpt)文件API的一份报告中报告。当添加到报告RptFile记者:

执行指定的报告Explorer设置文件生成一个报告的DocBook XML引渡Explorer报告
使用一个报告的修改版本浏览器Docbook-to-DOM转换模板转换的XML DOM对象的一组(见管理报告转换模板)
增加了DOM API报告内容。

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

创建

描述

例子

记者= RptFile ()创建一个空Explorer-based报告RptFile记者。之前记者的一份报告,报告程序必须设置记者的SetupFile属性的路径报告Explorer设置(.rpt)文件。否则,发生错误。

默认情况下,RptFile记者使用转换模板,是一个稍微的修改版本浏览器的默认转换模板报告输出类型。例如,如果报告输出类型是PDF,记者使用稍微修改版本浏览器的默认模板的报告PDF(模板)输出类型。

您可以使用自定义转换模板定制记者的输出。用记者的createTemplate方法来创建一个副本的一个记者的默认output-type-specific转换模板定制。使用自定义模板,设置RptFile记者的TemplateSrc属性来定制模板的路径。

例子

记者= RptFile (SetupFile)创建一个RptFile记者根据指定的报告Explorer设置文件(.rpt文件)。看到SetupFile财产。

记者= RptFile (名称=值)使用名称-值对集合属性。你可以在任何顺序指定多个参数名称-值对。

属性

全部展开

`SetupFile`- - - - - -报告Explorer设置文件路径
字符数组|字符串

报告Explorer设置文件路径,指定为一个字符数组或字符串。不使用基于表单的报告设置文件,你使用吗RptFile记者。

属性:

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

数据类型:字符数组|字符串

`TemplateSrc`- - - - - -源转换模板
`[]`|字符串|字符数组

源转换模板供记者安装文件的XML输出转换为DOM对象。空值指定使用默认模板生成报告的输出类型。一个字符串或字符数组值指定了路径的默认模板的定制版本生成输出类型。

属性:

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

数据类型:字符数组|字符串

`TemplateName`- - - - - -这个记者名字的模板
字符数组|字符串

模板的名字为这个记者,指定为一个字符数组或字符串。默认情况下,此属性指定RptFile,记者的默认模板的名称。这个默认模板驻留在其默认转换模板的模板库以及其他模板用于报告Explorer XML组件转换为DOM对象。默认的记者命名模板包含一个洞内容充满DOM内容转换生成的XML内容的设置。如果你改变这个模板的名称,您必须将此属性设置为新名称。你可以修改模板本身,但修改后的模板命名内容必须包含一个洞。

属性:

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

数据类型:字符数组|字符串

`LinkTarget`- - - - - -超链接的目标内容由记者
字符数组|字符串|`mlreportgen.dom.LinkTarget`对象

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

属性:

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

数据类型:字符数组|字符串|对象

方法

全部展开

公共方法

`createTemplate`	创建报告Explorer-based (RptFile)记者模板
`customizeReporter`	创建自定义报告Explorer-based记者类
`getClassFolder`	报告Explorer-based记者类定义文件的位置
`复制`	创建的副本记者对象,使深拷贝的某些属性值
`getImpl`	得到实现的记者

例子

创建一个RptFile记者

创建一个RptFile记者没有指定一个设置文件。然后,使用SetupFile属性指定报告Explorer设置文件。

记者= mlreportgen.report.RptFile ();记者。SetupFile =“my_setup_file.rpt”

添加Syntax-Highlighted代码来报告

使用RptFile记者在一份报告中添加的语法突出显示的代码API报告。

请注意

在你运行这个例子之前,使用报告Explorer创建一个设置文件命名highlight_syntax.rpt。安装文件对于这个示例包含一个格式化组件的文本编辑框中:

%导入报告API包,使用这个命令:% < code_var >

启用显示文本syntax-highlighted MATLAB代码,这是预格式化的文本框的下面。看到创建一个报告的设置文件。

这段代码创建了一个报告,其中包括报告APIhighlight_syntax.rpt设置文件。

rpt = mlreportgen.report.Report (“我的报告”,“pdf”);章= mlreportgen.report.Chapter…(”包括浏览器报告使用RptFile记者”);sect1 = mlreportgen.report.Section…(“强调语法的例子”);%对表达式求值,并将其分配给变量的代码evalin (“基地”,“code_var =“进口mlreportgen.report。*””);rptfile = mlreportgen.report.RptFile (“highlight_syntax.rpt”);add (sect1 rptfile)添加(小伙子,sect1)添加(rpt,小伙子)关闭(rpt) rptview (rpt)