mlreportgen.report.RptFile.createTemplate

Class: mlreportgen.report.RptFile
Package: mlreportgen.report

Create Report Explorer-based (RptFile) reporter template

Syntax

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


Description

template = mlreportgen.report.RptFile.createTemplate(templatePath,type) creates a copy of the default Report Explorer-based reporter (RptFile) template specified by type at the templatePath location. You can use the copied template as a starting point to design a custom RptFile reporter template for your report.

Input Arguments

templatePath — Path and file name of new template

character vector | string scalar

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

type — Type of template

'html' | 'html-file' | 'docx' | 'pdf'

Format of the output, specified as 'html', 'html-file', 'docx', or 'pdf'.

Output Arguments

template — Path and file name of template copy

string scalar

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 output type. For example, if type is 'pdf', the file name extension is .pdftx.

Examples

Create Report Explorer-based Reporter Template

Before you run this example, create a Report Explorer setup file (see Create a New Setup File) or use an existing setup file. In this example, the setup file is named mysetupfile.rpt. Then, create a copy of the default HTML RptFile template and edit it as desired. The copied template file in this example is named myrptfile.htmtx and is saved in a folder named mytemplates. To use the new template for the RptFile reporter, assign its path to the RptFile TemplateSrc property.

import mlreportgen.report.*
rpt = Report('My Report','html');
rptfile = RptFile('mysetupfile.rpt');
template = RptFile.createTemplate('mytemplates\myrptfile','html');
rptfile.TemplateSrc = template;