mlreportgen.dom.RawText class

Package: mlreportgen.dom

Word XML or HTML markup to insert in document

Description

Word XML or HTML markup to insert in a document.

The mlreportgen.dom.RawText class is a handle class.

Creation

Description

text = RawText() creates an empty RawText object.

You can append a RawText object only to a Document object. For a Word document, the markup specified by the DOCXText property is included in the document. For an HTML document, the value of the HTMLText property is included. In either case, the markup must be valid Word XML or HTML markup, respectively, that can be validly inserted in the body element of the output document. If you insert invalid markup in a Microsoft^® Word document, Word may be unable to open the document.

text = RawText(htmlMarkup) creates a RawText object containing the specified HTML markup.

text = RawText(markup,doctype) creates a RawText object containing markup of the specified document type (HTML or Word).

Input Arguments

htmlMarkup — HTML markup code

character vector

HTML markup, specified as a character vector. To improve the readability of your report document, consider assigning the markup to a variable. Then use the variable as an input argument, as shown in the example below.

markup — Word XML or HTML markup code

character vector

Word XML markup or HTML markup, specified as a character vector. For a Word document, the markup must be valid Word XML markup that can be inserted into the w:body element. To improve the readability of your report document, consider assigning the markup to a variable. Then use the variable as an input argument, as shown in the example below.

doctype — Type of markup to use

'html' | 'docx'

Type of markup to use, specified as a character vector.

Properties

DOCXText — Text to output to Word document

character vector

Word XML markup, specified as a character vector. The value of this property is included in a Word document. The markup must be valid Word XML markup that can be inserted into the w:body element of a Word document.

HTMLText — Text to output to HTML document

character vector

HTML markup, specified as a character vector. The value of this property is included in an HTML document. The text must be valid HTML markup that can be inserted into the body element of an HTML document.

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Examples

Add HTML Markup

Assign HTML markup to a variable and use that variable to create a RawText object to append to a document.

import mlreportgen.dom.*;
d = Document('test','html');

script = [ ...
   '<script>' ...
   'document.write("Hello World!")' ...
   '</script>' ...
   ];
append(d,RawText(script));

close(d);
rptview('test','html');

Version History

Introduced in R2014b