Main Content

mlreportgen.dom.Text Class

Namespace: mlreportgen.dom

Description

Use an object of the mlreportgen.dom.Text class to include text in a document.

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

Creation

Description

textObj = mlreportgen.dom.Text creates an empty Text object.

example

textObj = mlreportgen.dom.Text(text) creates a Text object that contains the specified text and sets the Content property to text.

textObj = mlreportgen.dom.Text(text,styleName) also specifies the style and sets the StyleName property to styleName. You must define the style in the style sheet in the template of the document to which you append this Text object.

Properties

expand all

Background color that consists of a CSS color name or a hexadecimal RGB value, specified as a character vector or string scalar.

Note

Setting the BackgroundColor property adds a mlreportgen.dom.BackgroundColor format object to the Style property. Setting the BackgroundColor property to an empty value removes the object.

Example: "blue"

Example: "#0000ff"

Attributes:

NonCopyable
true

Data Types: char | string

Option to use bold for this document element, specified as a numeric or logical 1 (true) or 0 (false). To make document element bold, set Bold to true or 1.

Note

Setting the Bold property adds a corresponding mlreportgen.dom.Bold format object to the Style property. Setting the Bold property to an empty value removes the object.

Attributes:

NonCopyable
true

Data Types: logical

Document element color that consists of a CSS color name (see https://www.w3.org/wiki/CSS/Properties/color/keywords) or a hexadecimal RGB (truecolor) value in the form #RRGGBB, specified as a character vector or string scalar.

Note

Setting the Color property adds a corresponding mlreportgen.dom.Color format object to the Style property. Setting the Color property to an empty value removes the object.

Example: "blue"

Example: "#0000ff"

Attributes:

NonCopyable
true

Data Types: char | string

Text contained by this document element, specified as a character vector or string scalar.

Attributes:

NonCopyable
true

Data Types: char | string

Name of a font family to use for text, specified as a character vector or string scalar. To specify substitutions for the font, do not specify the font family by setting this property. Instead, create and add an mlreportgen.dom.FontFamily object to the Style property.

Note

Setting the FontFamilyName property adds a corresponding mlreportgen.dom.FontFamily format object to the Style property. Setting the FontFamilyName property is the same as setting the FontName property of an mlreportgen.dom.FontFamily object. Setting the FontFamilyName property to an empty value removes the object.

Example: "Courier New"

Attributes:

NonCopyable
true

Data Types: char | string

Font size to use for document element that consists of a number followed by an abbreviation for a unit of measurement, specified as a character vector or string scalar . For example, "12pt" specifies twelve points. Valid abbreviations are:

  • "px" — pixels

  • "cm" — centimeters

  • "in" — inches

  • "mm" — millimeters

  • "pc" — picas

  • "pt" — points

Note

Setting the FontSize property adds a corresponding mlreportgen.dom.FontSize format object to the Style property. Setting the FontSize property to an empty value removes the object.

Example: "12pt"

Attributes:

NonCopyable
true

Data Types: char | string

Option to use italic for document element, specified as a numeric or logical 1 (true) or 0 (false). To make document element italic, set Italic to true or 1.

Note

Setting the Italic property adds a corresponding mlreportgen.dom.Italic format object to the Style property. Setting the Italic property to an empty value removes the object.

Attributes:

NonCopyable
true

Data Types: logical

Text strikethrough, specified as one of these values:

  • "none" — No strikethrough

  • "single" — Single line

  • "double" — Double line (for Word reports only)

Note

Setting the Strike property adds a corresponding mlreportgen.dom.Strike format object to the Style property for this document element. Setting the Strike property to an empty value removes the object.

Attributes:

NonCopyable
true

Data Types: char | string

Type of underline, specified as one of the values in this table.

Underline valueDescriptionSupported Output Types

"single"

Single line

All

"words"

Underline all characters except spaces

Word

"double"

Double line

Word

"thick"

Thick line

Word

"dotted"

Dotted line

Word

"dottedHeavy"

Thick dotted line

Word

"dash"

Dashed line

Word

"dashedHeavy"

Line with heavy dashes

Word

"dashLong"

Line with long dashes

Word

"dashLongHeavy"

Line with heavy long dashes

Word

"dotDash"

Dot-dash line

Word

"dashDotHeavy"

Heavy dash-dot line

Word

"dotDotDash"

Dot-dot-dash line

Word

"dashDotDotHeavy"

Line with heavy dashes and two dots between the dashes

Word

"wave"

Wavy line

Word

"wavyHeavy"

Heavy wavy

Word

"wavyDouble"

Double wavy line

Word

"none"

No underline

All

To specify both the color and the type of the underline, do not set the Underline property. Instead, set the Style property to include an mlreportgen.dom.Underline format object that specifies the underline type and color.

Note

Setting the Underline property adds a corresponding mlreportgen.dom.Underline format object to the Style property. Setting the Underline property to an empty value removes the object.

Attributes:

NonCopyable
true

Data Types: char | string

Type of white space and line breaks to use in text, specified as one of the values in the table. The WhiteSpace property does not apply when the Type property of the Document object is PDF.

ValueDescriptionSupported Output Types

"normal"

Does not preserve white space and line breaks.

Word and HTML

"nowrap"

Sequences of white space collapse into a single white space. Text never wraps to the next line.

HTML

"pre"

Preserves white space. Text wraps only on line breaks. Acts like the <pre> setting in HTML.

HTML

"preserve"

Preserves white space. Text wraps when necessary and on line breaks. Acts like the <pre-wrap> setting in HTML.

Word and HTML

"pre-line"

Sequences of white space collapse into a single white space. Text wraps.

HTML

"pre-wrap"

Preserves white space. Text wraps when necessary and on line breaks

HTML

If you want to view HTML output in the MATLAB® browser and you want to preserve white space and wrap text only on line breaks, use the preserve setting instead of the pre setting.

Note

Setting the WhiteSpace property adds a corresponding WhiteSpace format object to Style property. Removing the WhiteSpace property setting removes the WhiteSpace object.

Attributes:

NonCopyable
true

Data Types: string

Style name, specified as a character vector or a string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless overridden by the formats specified by the Style property of this element. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft® Word output ignores the style name.

Attributes:

NonCopyable
true

Data Types: char | string

Format specification for this document element object, specified as an array of format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this element are ignored.

Attributes:

NonCopyable
true

Data Types: cell

Custom attributes of this document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format of the document element to which this object is appended.

Attributes:

NonCopyable
true

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

Attributes:

SetAccess
private
NonCopyable
true

Children of mlreportgen.dom.Text object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

SetAccess
private
NonCopyable
true

Tag for mlreportgen.dom.Text object, 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. Specify your own tag value to help you identify where to look when an issue occurs during document generation.

Attributes:

NonCopyable
true

Data Types: char | string

Object identifier for mlreportgen.dom.Text object, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object. You can specify your own value for Id.

Attributes:

NonCopyable
true

Data Types: char | string

Methods

expand all

Examples

collapse all

In this example, you format a paragraph by using two separate mlreportgen.dom.Text objects so that each piece of text can have its own style. The first Text object underlines and bolds the text. The second Text object uses the default style.

Import the DOM API namespace so that you do not have to use long, fully qualified names.

import mlreportgen.dom.*

Create a Document object.

d = Document("mydoc","html");

Create a Paragraph object.

para = Paragraph();

Create a Text object for the text that you want to bold and underline. Append the Text object to the Paragraph object,

paraTitle = Text("Results:");
paraTitle.Bold = true;
paraTitle.Underline = "single";
append(para,paraTitle);

Create a Text object for the rest of the text in the paragraph and append the Text object to the Paragraph object.

paraContent = Text(" Study 1");
append(para,paraContent);
append(d,para);

Close and view the report.

close(d);
rptview(d);

Here is the generated paragragh:

Version History

Introduced in R2014b