mlreportgen.dom.CustomText class

Package: mlreportgen.dom
Superclasses:

Plain text appended to custom element

Description

Plain text to append to a custom element.

Construction

customTextObj = CustomText() creates an empty CustomText object.

customTextObj = CustomText(text) creates a CustomText object containing the specified text.

Input Arguments

text — Text to append to custom element

character vector

Text to append to custom element, specified as a character vector.

Output Arguments

customTextObj — Text to append to custom element

mlreportgen.dom.CustomText object

Text to append to a custom element, returned as an mlreportgen.dom.CustomText object.

Properties

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

Value — Text to add

character vector

Text to add to a custom element, specified as a character vector.

Examples

Create Custom Text for a Script

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

script = CustomElement('script');
append(script,CustomText('document.write("Hello World!")'));
append(d,script);

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