本页采用了机器翻译。点击此处可查看英文原文。

mlreportgen.report.RptFile 类

命名空间: mlreportgen.report
超类: mlreportgen.report.Reporter

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

全页展开

描述

使用 RptFile 报告器将报告资源管理器设置 (.rpt) 文件生成的内容包含在报告 API 报告中。当添加到报告中时，RptFile 报告器：

  1. 执行指定的报告资源管理器设置文件以生成报告资源管理器报告的 DocBook XML 版本

  2. 使用修改版本的报告资源管理器 Docbook-to-DOM 转换模板将 XML 转换为一组 DOM 对象（请参阅 管理报告转换模板）

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

mlreportgen.report.RptFile 类是一个 handle 类。

创建对象

描述

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

默认情况下，RptFile 报告器使用的转换模板是报告资源管理器针对报告输出类型的默认转换模板的稍微修改版本。例如，如果报告输出类型为 PDF，则报告器将使用报告资源管理器的 PDF (from template) 输出类型的默认模板的稍微修改版本。

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

示例

reporter = RptFile(SetupFile) 根据指定的报告资源管理器设置文件（.rpt 文件）创建一个 RptFile 报告器。查看 SetupFile 属性。

示例

reporter = RptFile(PropertyName=Value) 使用名称-值参量设置属性。您可以按任意顺序指定多个名称-值参量。

属性

全部展开

报告资源管理器设置文件路径，指定为字符向量或字符串。请勿将基于表单的报告用作与 RptFile 报告器一起使用的设置文件。

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

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

属性：

GetAccess
public
SetAccess
public

数据类型: char | string

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标在输出报告中紧接着此报告器的内容。

属性：

GetAccess
public
SetAccess
public

方法

全部展开

示例

全部折叠

  1. 创建一个 RptFile 报告器而不指定设置文件。 

    reporter = mlreportgen.report.RptFile();

  2. 使用 SetupFile 属性指定报告资源管理器的设置文件。

    reporter.SetupFile = "my_setup_file.rpt";

  1. 使用“报告资源管理器”创建一个名为 highlight_syntax.rpt 的设置文件。此示例的设置文件包含预格式化的组件，其编辑框中含有以下文本： 

    % To import the Report API namespace, use this command:
%<code_var>

  2. 启用“预格式化”文本框下方的将文本显示为语法高亮的 MATLAB 代码。请参阅使用报告资源管理器创建报告。

    Report Explorer showing the box Show text as syntax-highlighted MATLAB code selected in the Properties pane

  3. 此代码创建一个包含 highlight_syntax.rpt 设置文件的报告 API 报告。

    rpt = mlreportgen.report.Report("My Report","pdf");

chap = mlreportgen.report.Chapter...
  ("Include Report Explorer Report Using the RptFile Reporter");
sect1 = mlreportgen.report.Section...
  ("Highlighted Syntax Example");

% Evaluate the expression and assign it to the code variable
evalin("base","code_var = ""import mlreportgen.report.*""");

rptfile = mlreportgen.report.RptFile("highlight_syntax.rpt");

add(sect1,rptfile)
add(chap,sect1)
add(rpt,chap)

close(rpt)
rptview(rpt)

    Report sample showing Chapter 1. Include Report Explorer Report Using the RptFile Reporter, section 1.1 Highlighted Syntax Example, and a code sample that shows "% To import the Report API Package, use this command:" in green, "import" in black and "mlreportgen.report.*" in red

版本历史记录

在 R2019a 中推出

另请参阅

|

主题