mlreportgen.report.TextFile Class

Namespace: mlreportgen.report
Superclasses: mlreportgen.report.Reporter

Text file reporter

Since R2023a

Description

Create a reporter to report on text files.

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

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

reporter = TextFile creates an empty TextFile reporter object based on a default template. Use its properties to specify a text file on which to report and to specify report options. You must specify a text file name to be reported. Adding an empty TextFile reporter object, that is, one that does not specify a file name, to a report, produces an error.

reporter = TextFile(filename) creates a TextFile reporter object with the FileName property set to filename. Adding this reporter to a report, without any further modification, adds the text file content to the generated report. Use the reporter's properties to customize the report options.

reporter = TextFile(p1,v1,p2,v2,...) creates a TextFile reporter and initializes properties (p1,p2,...) to the specified values (v1,v2,...).

Properties

FileName — Path or name of the text file

[] (default) | character vector | string scalar

Path or name of the text file, specified as a character vector or string scalar.

Example: tf.FileName = "Name of File"

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

ImportFileAsParagraph — Whether to import the file as a paragraph

1 (true) (default) | 0 (false)

Whether to import the file as a DOM Paragraph or DOM Text object, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Import the file as a DOM Paragraph object. The input is broken into paragraphs at values set by the ParaSep property. Use ParagraphFormatter property whose value is a DOM Paragraph object to format the DOM Paragraph objects.

• 0 (false) — Import the text file as a DOM Text object. Use TextFormatter property whose value is a DOM Text object to format the DOM Text object.

Example: "ImportFileAsParagraph","false"

Attributes:

GetAccess	public
SetAccess	public

Data Types: logical

ParaSep — Specify how the input is separated

[] (default) | character vector | string scalar

Paragraph separator, specified as a character vector or string scalar. Use this property to specify the separator used to break the input into paragraphs. You can use any separator. For example, newline separates the input text at a line break and wraps the text into paragraphs.

Example: "ParaSep","char(10)"

Attributes:

GetAccess	public
SetAccess	public

Data Types: char | string

ParagraphFormatter — Paragraph formatter for the TextFile reporter

mlreportgen.dom.Paragraph

If the ImportFileAsParagraph property for the TextFile reporter is true, the reporter appends a plain text paragraph to a copy of this object and appends it to the report. Use mlreportgen.dom.Paragraph object properties to format a plain text paragraph by setting the properties of the default paragraph or by replacing the default paragraph with a custom paragraph. Content that you add to the default or replacement paragraph appears before the content of the generated report.

Example: "ParagraphFormatter.Color","red"

Attributes:

GetAccess	public
SetAccess	public

TextFormatter — Text formatter for the TextFile reporter

mlreportgen.dom.Text

If the ImportFileAsParagraph property for the TextFile reporter is false, the reporter appends a plain text content to a copy of this object and appends it to the report. Use the mlreportgen.dom.Text object properties to format a plain text content. Content that you add to the default appears before the content of the generated report.

Example: "TextFormatter.Color","red"

Attributes:

GetAccess	public
SetAccess	public

TemplateSrc — Source of template for this reporter

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 this reporter uses or whose template library contains the template for this reporter

• Document Object Model (DOM) document or document part whose template this reporter uses or whose template library contains the template for this reporter

The specified template must be the same type as the report to which you append this reporter. 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
NonCopyable	true
Dependent	true

TemplateName — Name of template for this 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

Data Types: char | string

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 converts 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

Method	Purpose
mlreportgen.report.TextFile.createTemplate	Create reporter template template = createTemplate(templatePath,templateType) creates a copy of the default template for the report type specified by templateType at the location specified by templatePath. You can use the copied template as a starting point to design a custom reporter template for your report. Input Arguments templatePath — Target path and file name for template file, specified as a character vector or a string scalar. templateType — Template type, specified as "html", "docx", or "pdf" Return Values template — Path and file name of the template copy, returned as a string scalar For more information, see the method for the Reporter class, mlreportgen.report.Reporter.createTemplate.
mlreportgen.report.TextFile.customizeReporter	Create reporter from mlreportgen.report.TextFile class classPathOut = customizeReporter(classPath) creates a reporter class definition file that defines a subclass of mlreportgen.report.TextFile at the location specified by classPath. The method copies the default reporter templates to the resources/templates subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom reporter class. Input Arguments classPath — Path and name of the new class definition file, specified as a character vector or string scalar Return Values classPathOut — Path and file name of the new class, returned as a string scalar For more information, see the method for the mlreportgen.report.Reporter class, mlreportgen.report.Reporter.customizeReporter.
mlreportgen.report.TextFile.getClassFolder	Get location of folder that contains mlreportgen.report.TextFile class definition file path = getClassFolder returns the path of the folder that contains the class definition file. Return Values path — Class definition file location, returned as a character vector For more information, see the method for the Reporter class, mlreportgen.report.Reporter.getClassFolder.
copy	Create copy of reporter object and make deep copies of property values copiedObj = copy(reporterObj) returns a copy of the specified reporter object. The returned copy contains a deep copy of any property value of reporterObj that references a reporter, DOM object, or mlreportgen.report.ReporterLayout object. As a result, you can modify the properties of the original or new object without affecting the other object. Input Arguments reporterObj — Reporter object to copy, specified as an object of a reporter class Return Values copiedObj — Copy of reporter, returned as an object of a reporter class For more information, see the method for the mlreportgen.report.Reporter class, copy.
getImpl	Get implementation of reporter impl = getImpl(reporter,report) returns the Document Object Model (DOM) object that implements the reporter, reporter, when you append it to the report, report. Note You cannot add content to the reporter after calling this method. Input Arguments reporterObj— Reporter object, specified as an object of mlreportgen.report.Reporter or an object of a subclass of mlreportgen.report.Reporter report — Report, specified as a mlreportgen.report.Report object Return Values impl — Implementation object, returned as a DOM object. For more information, see the method for the mlreportgen.report.Reporter class, getImpl.

Examples

Import Text File as a Paragraph

Create a report from text file as a paragraph.

First, create a text file and save it as my_script.txt to use with this example. Next, import the report API namespaces so that you do not have to use long fully qualified class names.

import mlreportgen.report.*

Create a PFD report.

rpt = Report("MyReport","pdf");
open(rpt);

Create an empty chapter.

chap = Chapter("TextFile Reporter");

Create a TextFile reporter. Specify a paragraph separator so the report creates a new paragraph at each newline character.

rptr = TextFile("my_script.txt");
rpt.ParaSep = [newline newline];

Append the reporter to the chapter and append the chapter to the report.

append(chap,rptr);
append(rpt,chap);

Close and view the report.

close(rpt);
rptview(rpt);

Version History

Introduced in R2023a