mlreportgen.report.RptFileclass

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

创建基于报表管理器的报告器

展开页内所有内容

描述

使用RptFile报告程序，以包含报表资源管理器设置生成的内容(.rpt)在报告中提交API报告。当添加到报表时，RptFile记者:

执行指定的报表资源管理器设置文件，以生成报表资源管理器报表的DocBook XML格式
使用Report Explorer Docbook-to-DOM转换模板的修改版本，将XML转换为一组DOM对象(请参阅管理报表转换模板)
将DOM内容添加到报告API报告中。

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

创建

描述

例子

记者= RptFile ()创建一个空的基于报表管理器RptFile记者。在将报告程序添加到报告程序之前，您的报告程序必须设置报告程序SetupFile属性设置为报表资源管理器设置路径(.rpt)文件。否则，将出现错误。

默认情况下,RptFile报告程序使用的转换模板是报表资源管理器的报表输出类型的默认转换模板的一个稍微修改过的版本。例如，如果报表输出类型为PDF，则报告器将使用报表资源管理器的默认模板的一个稍微修改过的版本PDF(模板)输出类型。

您可以使用自定义转换模板来自定义报告器输出。用记者的createTemplate方法创建用于自定义的报告器的默认特定于输出类型的转换模板之一的副本。要使用自定义模板，请设置RptFile记者的TemplateSrc属性设置为自定义模板的路径。

例子

记者= RptFile (SetupFile)创建一个RptFile报告程序基于指定的报表资源管理器设置文件(.rpt文件)。看到SetupFile财产。

记者= RptFile (名称,值)使用名称-值对设置属性。可以按任意顺序指定多个名称-值对参数。将每个属性名称用单引号括起来。

属性

全部展开

`SetupFile`- - - - - -报告资源管理器安装文件路径
字符数组|字符串

报表资源管理器设置文件路径，指定为字符数组或字符串。对于与?一起使用的安装文件，不要使用基于表单的报表RptFile记者。

属性:

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

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

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

转换模板的源文件，该报告器将使用它将设置文件的XML输出转换为DOM对象。空值指定使用要生成的报表的输出类型的默认模板。字符串或字符数组值指定要生成的输出类型的默认模板的自定义版本的路径。

属性:

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

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

`TemplateName`- - - - - -此记者的模板名称
字符数组|字符串

此报告器的模板名称，指定为字符数组或字符串。默认情况下，此属性指定RptFile，报告者的默认模板的名称。此默认模板驻留在其默认转换模板的模板库中，以及用于将Report Explorer XML组件转换为DOM对象的其他模板。默认的报告器模板包含一个名为内容用从设置生成的XML内容转换过来的DOM内容填充。如果更改此模板的名称，则必须将此属性设置为新名称。您可以修改模板本身，但是修改后的模板必须包含一个名为Content的孔。

属性:

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

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

`LinkTarget`- - - - - -本报告创建的内容的超链接目标
字符数组|字符串|`mlreportgen.dom.LinkTarget`对象

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

属性:

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

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

方法

全部展开

公共方法

`createTemplate`	创建基于报表管理器(RptFile)的报告模板
`customizeReporter`	创建自定义报告Explorer-based记者类
`getClassFolder`	基于报表管理器的报告器类定义文件位置
`复制`	创建报告器对象的副本，并对引用报告器、ReporterLayout或DOM对象的属性值进行深度复制
`getImpl`	获取报告程序的实现

例子

创建一个RptFile报告器

创建一个RptFile没有指定安装文件的报告程序。然后,使用SetupFile属性指定报表资源管理器设置文件。

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

将语法突出显示的代码添加到报表中

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

请注意

在运行此示例之前，使用报表资源管理器创建一个名为highlight_syntax.rpt。这个例子的安装文件包含一个预格式化的组件，在它的编辑框中有这个文本:

%导入报告API包，使用以下命令:%

启用将文本显示为突出显示语法的MATLAB代码，它位于预格式化文本框的下面。看到创建一个报告设置文件。

此代码创建一个报告API报告，其中包括highlight_syntax.rpt设置文件。

rpt = mlreportgen.report.Report (“我的报告”,“pdf”);章= mlreportgen.report.Chapter…(“使用RptFile报告器包括报表资源管理器报表”);sect1 = mlreportgen.report.Section…(“强调语法的例子”);%对表达式求值并将其分配给代码变量evalin (“基地”,'code_var = "导入mlreport .report.*"');rptfile = mlreportgen.report.RptFile (“highlight_syntax.rpt”);添加(sect1,rptfile)添加(chap,sect1)添加(rpt,chap)关闭(rpt) rptview(rpt)