mlreportgen.report.RptFile Class

Namespace: mlreportgen.report
Superclasses: mlreportgen.report.Reporter

Create Report Explorer-based reporter

Description

Use the RptFile reporter to include the content generated by a Report Explorer setup (.rpt) file in a Report API report. When added to a report, the RptFile reporter:

1. Executes the specified Report Explorer setup file to generate a DocBook XML rendition of the Report Explorer report

2. Uses a modified version of the Report Explorer Docbook-to-DOM conversion template to convert the XML to a set of DOM objects (see Manage Report Conversion Templates)

3. Adds the DOM content to the Report API report.

The mlreportgen.report.RptFile class is a handle class.

Creation

Description

reporter = RptFile creates an empty Report Explorer-based RptFile reporter. Before adding the reporter to a report, your report program must set the reporter's SetupFile property to the path of a Report Explorer setup (.rpt) file. Otherwise, an error occurs.

By default the RptFile reporter uses a conversion template that is a slightly modified version of the Report Explorer's default conversion template for the report output type. For example, if the report output type is PDF, the reporter uses a slightly modified version of the default template for the Report Explorer's PDF (from template) output type.

You can use a custom conversion template to customize the reporter output. Use the reporter's mlreportgen.report.RptFile.createTemplate method to create a copy of one of the reporter's default output-type-specific conversion templates for customization. To use the customized template, set the RptFile reporter's TemplateSrc property to the path of the customized template.

reporter = RptFile(SetupFile) creates a RptFile reporter based on the specified Report Explorer setup file (.rpt file). See the SetupFile property.

reporter = RptFile(PropertyName=Value) sets properties using name-value arguments. You can specify multiple name-value arguments in any order.

Properties

SetupFile — Report Explorer setup file path

character vector | string scalar

Report Explorer setup file path, specified as a character vector or string. Do not use form-based reports for setup files that you use with the RptFile reporter.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

TemplateSrc — Source of conversion template

[] (default) | character vector | string scalar

Source of conversion template to be used by this reporter to convert the setup file's XML output to DOM objects. An empty value specifies use of the default template for the output type of the report to be generated. A character vector or string scalar value specifies the path of a customized version of the default template for the output type to be generated.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

TemplateName — Name of template for this reporter

"RptFile" (default) | character vector | string scalar

Name of template for this reporter, specified as a character vector or string. By default this property specifies RptFile, the name of the reporter's default template. This default template resides in the template library of its default conversion template along with other templates used to convert Report Explorer XML components to DOM objects. The default reporter template contains a single hole named Content to be filled with the DOM content converted from the XML content generated by the setup. If you change the name of this template, you must set this property to the new name. You can modify the template itself, but the modified template must contain a hole named Content.

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

LinkTarget — Hyperlink target for this reporter

[] (default) | character vector | string scalar | mlreportgen.dom.LinkTarget object

Hyperlink target for this reporter, specified as a character vector or string scalar that specifies the link target ID, or an mlreportgen.dom.LinkTarget object. A character vector or string scalar value converts to a LinkTarget object. The link target immediately precedes the content of this reporter in the output report.

Attributes:

GetAccess	public
SetAccess	public

Methods

Public Methods

Method	Purpose
mlreportgen.report.RptFile.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, mlreportgen.report.Reporter.createTemplate.
mlreportgen.report.RptFile.customizeReporter	Create reporter from mlreportgen.report.RptFile class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of mlreportgen.report.RptFile at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the mlreportgen.report.Reporter class, mlreportgen.report.Reporter.customizeReporter.
mlreportgen.report.RptFile.getClassFolder	Get location of folder that contains mlreportgen.report.RptFile class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, mlreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or mlreportgen.report.ReporterLayout object. As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the mlreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of mlreportgen.report.Reporter or an object of a subclass of mlreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the mlreportgen.report.Reporter class, getImpl.

Examples

Create a RptFile Reporter

1. Create an RptFile reporter without specifying a setup file.

   reporter = mlreportgen.report.RptFile();
    

2. Use the SetupFile property to specify the Report Explorer setup file.

   reporter.SetupFile = "my_setup_file.rpt"; 

Add Syntax-Highlighted Code to a Report

1. Use the Report Explorer to create a setup file named highlight_syntax.rpt. The setup file for this example contains a Preformatted component with this text in its edit box:

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

2. Enable Show text as syntax-highlighted MATLAB code, which is below the Preformatted text box. See Use Report Explorer to Create Reports.

   

3. This code creates a Report API report that includes the highlight_syntax.rpt setup file.

   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)
   

   

Version History

Introduced in R2019a