Report Generator Creation

Create a MATLAB^® program to generate a Microsoft^® Word, HTML, or PDF report

Use the MATLAB Report Generator™ application programming interface (API) to create programs to generate reports. To get started, see Create Report Programs. Other topics below have details about the required and optional tasks, and the elements that make up a report generator program. For general information on reporters, see What Are Reporters?

To share your report generation program with others who do not have MATLAB installed on their systems, see Create Standalone Applications from Report Programs.

Classes

expand all

Report Containers and Base Classes

`mlreportgen.report.Report`	Report container
`mlreportgen.dom.Document`	Document container
`mlreportgen.dom.Container`	Container of document objects
`mlreportgen.report.Reporter`	Superclass for MATLAB reporters
`mlreportgen.finder.Finder`	Base class for finders
`mlreportgen.finder.Result`	Base class for finder results

Progress, Error, Warning, and Debug Messages

mlreportgen.dom.MessageDispatcher

mlreportgen.dom.MessageEventData

mlreportgen.dom.MessageFilter

mlreportgen.dom.DebugMessage

mlreportgen.dom.ErrorMessage

mlreportgen.dom.ProgressMessage

mlreportgen.dom.WarningMessage

Functions

expand all

Report Display and Conversion

`rptview`	Display report or presentation
`docview`	View or perform operations on Word document
`rptconvert`	Convert DocBook XML files generated by Report Explorer to formatted reports
`mlreportgen.dom.enableDOCXUpdateOnOpen`	Display dialog box when DOCX document opens (Since R2022b)

Topics

Overview

Create Report Programs
Get an overview and general information about creating a report program.

Required Report Tasks and Elements

Create Report Containers
Create report object to hold report content.
Construct Report API or DOM API Objects
Construct objects using API classes.
Add Content to Reports
Use append to add content to Report API or DOM API reports and report elements.
Close Reports
The last step in creating a report with the DOM API is to close the report.

Optional Report Tasks and Elements

Import API namespaces
Import namespaces so that you do not have to use long, fully qualified class names.
Display Progress and Debugger Messages
Specify messages to display when generating a report.
Display Reports
Display the generated report in a viewer.
Create Standalone Applications from Report Programs
Enable sharing of report generation programs with users who do not have MATLAB installed.
Create a Custom Reporter Without a Template
Add content to multiple reports by redefining methods in a custom reporter.