mlreportgen.dom.CustomText Class

Namespace: mlreportgen.dom

Append plain text to custom element

expand all in page

Description

Use an object of the mlreportgen.dom.CustomText class to append plain text 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

expand all

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

Output Arguments

expand all

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

Properties

expand all

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

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess
public
SetAccess
private
NonCopyable
true

Tag, specified as a character vector or string scalar. The DOM API 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. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Methods

Method

Purpose

clone

copiedObj = clone(soureceObj) returns a copy of the mlreportgen.dom.CustomText object specified by soureceObj. The copy includes the children of the source object, but not the parent.

Note

Do not append the same object to a document more than once. Use clone to create a copy when you want to reuse the same content elsewhere in a document.

Input Arguments

  • soureceObj — Object to clone, specified as an mlreportgen.dom.CustomText object

Return Values

  • copiedObj— Object copy, returned as an mlreportgen.dom.CustomText object

For more information, see the equivalent method for the mlreportgen.dom.Paragraph class, clone.

Examples

collapse all

Open Live 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');

Version History

Introduced in R2014b

See Also

|