Main Content

mlreportgen.report.ListOfCaptions.createTemplate

Class: mlreportgen.report.ListOfCaptions
Package: mlreportgen.report

Create list of captions reporter template

Syntax

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

Description

template = mlreportgen.report.ListOfCaptions.createTemplate(templatePath,type) 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

Path and file name of the new template, specified as a character vector or string scalar.

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

Output Arguments

expand all

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

Examples

expand all

Create a copy of the HTML template for the mlreporten.report.ListOfCaptions reporter and save it with the name myListOfCaptionsTemplate in the mytemplates folder.

template = mlreportgen.report.ListOfCaptions.createTemplate...
     ('mytemplates/myListOfCaptionsTemplate','html');

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

Introduced in R2020b