主要内容

mlreportgen.report.RptFile类

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

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

描述

使用RptFilereporter以包括报表资源管理器设置生成的内容(.rpt)文件在报告API报告中。添加到报告时,RptFile记者:

  1. 执行指定的报表资源管理器安装文件,以生成报表资源管理器报表的DocBook XML格式副本

  2. 使用报表资源管理器Docbook到DOM转换模板的修改版本将XML转换为一组DOM对象(请参见管理报表转换模板)

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

这个mlreportgen.report.rpt文件类是一个手柄

创造

描述

实例

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

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

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

实例

reporter=RptFile(SetupFile)创建一个RptFile基于指定的报表资源管理器安装文件(.rpt文件)。看到设置文件所有物

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

性质

全部展开

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

属性:

GetAccess
公共
设置访问
公共

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

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

属性:

GetAccess
公共
设置访问
公共

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

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

属性:

GetAccess
公共
设置访问
公共

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

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

属性:

GetAccess
公共
设置访问
公共

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

方法

全部展开

例子

创建一个文件报告器

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

reporter=mlreportgen.report.RptFile();reporter.SetupFile=“my_setup_file.rpt”

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

使用RptFilereporter向报表API报表中的代码添加语法突出显示。

笔记

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

%要导入报表API包,请使用以下命令:%%
使可能将文本显示为语法突出显示的MATLAB代码,位于预格式化文本框下方。请参阅创建报告设置文件.

此代码创建一个Report API报告,其中包括highlight_syntax.rpt安装文件。

rpt=mlreportgen.report.report(“我的报告”,“pdf”);chap=mlreportgen.report.Chapter...(“使用RptFile报告器包括报告资源管理器报告”);sect1 = mlreportgen.report.Section...(“突出显示的语法示例”);%计算表达式并将其指定给代码变量埃瓦林(“基地”,'code_var = "导入mlreportgen.report.*"');rptfile = mlreportgen.report.RptFile (“highlight_syntax.rpt”);添加(sect1,rptfile)添加(chap,sect1)添加(rpt,chap)关闭(rpt)rpt视图(rpt)

在R2019a中引入