mlreportgen.report.Reporter class

Package: mlreportgen.report

Superclass for MATLAB reporters

Description

mlreportgen.report.Reporter is a superclass for reporter objects that generate content to add to a report. The format of a reporter is based on a template.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

reporter = mlreportgen.report.Reporter() creates an empty reporter.

report = mlreportgen.report.Reporter(Name=Value) sets properties using name-value pairs. You can specify multiple name-value pair arguments in any order.

Properties

TemplateSrc — Source of template for reporter

[] (default) | character vector | string scalar | reporter or report | DOM document or document part

Source of the template for this reporter, specified in one of these ways:

• Character vector or string scalar that specifies the path of the file that contains the template for this reporter

• Reporter or report whose template is used for this reporter or whose template library contains the template for this reporter

• DOM document or document part whose template is used for this reporter or whose template library contains the template for this reporter

The specified template must be the same type as the report to which this reporter is appended. For example, for a Microsoft^® Word report, TemplateSrc must be a Word reporter template. If the TemplateSrc property is empty, this reporter uses the default reporter template for the output type of the report.

Attributes:

GetAccess	public
SetAccess	public

TemplateName — Name of template for reporter

character vector | string scalar

Name of the template for this reporter, specified as a character vector or string scalar. The template for this reporter must be in the template library of the template specified by the TemplateSrc property of this reporter.

Attributes:

GetAccess	public
SetAccess	public

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 is converted 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

copy	Create copy of reporter object and make deep copies of certain property values
getImpl	Get implementation of reporter
mlreportgen.report.Reporter.createTemplate	Create reporter template
mlreportgen.report.Reporter.customizeReporter	Create class derived from Reporter class
mlreportgen.report.Reporter.getClassFolder	Get location of folder containing mlreportgen.report.Reporter class definition file

Version History

Introduced in R2017b