Main Content

mlreportgen.report.ListOfCaptions.createTemplate

Class: mlreportgen.report.ListOfCaptions
Namespace: mlreportgen.report

Create list of captions reporter template

Since R2020b

expand all in page

Syntax

template = mlreportgen.report.ListOfCaptions.createTemplate(templatePath,templateType)

Description

template = mlreportgen.report.ListOfCaptions.createTemplate(templatePath,templateType) creates a copy of the mlreportgen.report.ListOfCaptions reporter template for the report type specified by type at the location specified by templatePath. You can use the copied template as a starting point to design a custom list of captions reporter template for your report.

Input Arguments

expand all

Target path and file name of copy of template file, specified as a character vector or string scalar. If you specify templatePath without the file extension, the method creates the file with the extension of the copied template file. If you include the file extension, it must match the extension of the copied template file.

Data Types: char | string

Type of template, specified as "html", "html-file", "docx", or "pdf".

Data Types: char | string

Output Arguments

expand all

Path and file name of the template copy, returned as a string scalar. The specified template type determines the file name extension of the template. For example, if the type argument is "pdf", the file name extension is ".pdftx".

Data Types: string

Examples

expand all

Create a copy of the HTML template for your particular slreportgen.report class and save it with the name myTemplate in the mytemplates folder. This example uses the slreportgen.report.Reporter class, but the process is the same for any createTemplate method.

template = slreportgen.report.Reporter.createTemplate ...
     ("mytemplates/myTemplate","html");

After you modify the template, you can use it by setting the TemplateSrc property of a reporter to the path of the template file.

Version History

Introduced in R2020b

See Also