主要内容

mlreportgen.report.RptFile类

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

创建基于报表资源管理器的报表

描述

使用RptFile报告程序,以包含由报表资源管理器设置(.rpt)文件在报告API报告中。添加到报告时,RptFile记者:

  1. 执行指定的报表资源管理器设置文件,以生成报表资源管理器报表的DocBook XML呈现

  2. 使用经过修改的Report Explorer Docbook-to-DOM转换模板将XML转换为一组DOM对象(参见管理报表转换模板

  3. 将DOM内容添加到Report API报告中。

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

创建

描述

例子

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

默认情况下,RptFile报表使用一个转换模板,该转换模板是报表资源管理器针对报表输出类型的默认转换模板的轻微修改版本。例如,如果报表输出类型是PDF,报表使用对报表资源管理器的默认模板稍加修改的版本PDF(模板)输出类型。

您可以使用自定义转换模板来自定义报表输出。用记者的createTemplate方法创建报告程序的一个默认输出类型特定的转换模板的副本,以进行自定义。若要使用自定义模板,请设置RptFile记者的TemplateSrc属性设置为自定义模板的路径。

例子

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

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

属性

全部展开

报告资源管理器设置文件路径,指定为字符数组或字符串。不要将基于表单的报告用于与RptFile记者。

属性:

GetAccess
公共
SetAccess
公共

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

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

属性:

GetAccess
公共
SetAccess
公共

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

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

属性:

GetAccess
公共
SetAccess
公共

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

该报告器的超链接目标,指定为指定链接目标ID的字符数组或字符串,或mlreportgen.dom.LinkTarget对象。将字符串或字符数组值转换为LinkTarget对象。在输出报告中,链接目标对象紧接在该报告内容的前面。

属性:

GetAccess
公共
SetAccess
公共

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

方法

全部展开

例子

创建RptFile Reporter

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

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

向报告添加语法高亮显示的代码

使用RptFile添加语法高亮显示到报表API报表的代码中。

请注意

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

%导入报告API包,使用命令:%
启用以语法高亮显示的MATLAB代码显示文本,位于“预格式化”文本框下方。看到创建报告安装文件

此代码创建一个Report API报告,其中包括highlight_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) Add (chap,sect1) Add (rpt,chap) close(rpt) rptview(rpt)

介绍了R2019a