mlreportgen.dom.Text class

Package: mlreportgen.dom
Superclasses:

Text object

Description

Text to include in a document element

Construction

textObj = Text() creates an empty text object.

textObj = Text(text) creates a text object containing the specified text.

textObj = Text(text,styleName) creates a text object containing the specified text using the specified style. The style must be defined in the style sheet of the template of the document to which this text object is appended.

Input Arguments

text — Text

array of chars

Array of chars containing the text

Data Types: char

styleName — Style for the text

mlreportgen.dom.StyleName object

The style specified by styleName must be defined in the template used to create the document to which this text is appended.

Data Types: char

Output Arguments

textObj — Text

mlreportgen.dom.Text object

Text, returned as an mlreportgen.dom.Text object.

Properties

BackgroundColor — Background color

character vector

Background color, specified as either:

• The name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

Bold — Option to use bold for text

[] (default) | logical value

To make text bold, set this property to true or 1. If this property is empty and the StyleName property for this document element specifies a style sheet style, the weight of the text is determined by that style. Setting the Bold property adds a corresponding mlreportgen.dom.Bold format object to the Style property of this document element. Removing the Bold property setting removes the object.

Data Types: logical

Color — Text color

character vector

Text color, specified as either:

• The name of a color. The name must be a CSS color name. See https://www.crockford.com/wrrrld/color.html.

• A hexadecimal RGB (truecolor) value as #RRGGBB. For example, #0000ff is a shade of blue.

Content — Text contained by this document element

character vector

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

CustomAttributes — Custom attributes of document element

array of mlreportgen.dom.CustomAttribute objects

The output format must support the custom attributes of this document element.

FontFamilyName — Name of font family for text

character vector

The name of a font family.

To specify substitutions for this font, do not set this property. Instead create and add a mlreportgen.dom.FontFamily object to the Style property of this document element.

Setting the FontFamilyName property adds a corresponding mlreportGen.dom.FontFamily format object to the Style property for this document element. Setting the FontFamilyName property is the same as setting the FontName property of mlreportgen.dom.FontFamily. Removing the FontFamilyName property setting removes the object.

FontSize — Font size for text

character vector

If you need to specify substitutions for this font, do not set this property. Instead create and add a mlreportgen.dom.FontFamily object to the Style property of this document element.

Setting the FontSize property adds a corresponding mlreportGen.dom.FontSize format object to the Style property for this document element. Removing the FontSize property setting removes the object.

Font size for text, in the form valueUnits, where Units is an abbreviation for the units. Use one of these abbreviations for the units:

• px — pixels (default)

• cm — centimeters

• in — inches

• mm — millimeters

• pc — picas

• pt — points

Id — ID for document element

character vector

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

Italic — Option to use italics for text

[] (default) | logical value

To use italics for text, set this property to true. If this property is empty and the StyleName property for this document element specifies a style sheet style, the slant of the text is determined by that style. Setting the Italic property adds a corresponding mlreportgen.dom.Italic format object to the Style property of this document element. Removing the Italic property setting removes the object.

Data Types: logical

Strike — Text strikethrough

[] (default) | 'none' | 'single' | 'double'

Text strikethrough, specified as one of these values:

• 'none' — Do not use strikethrough.

• 'single' — Use a single line for strikethrough.

• 'double' — Use a double line for strikethrough for Word documents.

Setting the Strike property adds a corresponding mlreportGen.dom.Strike format object to the Style property for this document element. Removing the Strike property setting removes the object.

Style — Text formatting

array of DOM style objects

An array of DOM style objects that specifies the format for the text.

StyleName — Style for the text

character vector

The style specified by StyleName must be defined in the template used to create the document element to which this text is appended.

Tag — Tag for document element

character vector

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.

Underline — Type of underline, if any, for text

[] (default) | character vector

You can specify one of the following types of underlines.

Border Value	Description	Supported Output Types
'dash'	Dashed underline	Word
'dashedHeavy'	Line with heavy dashes	Word
'dashLong'	Line with long dashes	Word
'dashLongHeavy'	Line with heavy long dashes	Word
'dashDotDotHeavy'	Line with heavy dashes with two dots between the dashes	Word
'dashDotHeavy'	Heavy dash-dot line	Word
'dotted'	Dotted line	Word
'dottedHeavy'	Thick dotted line	Word
'dotDash'	Dot-dash line	Word
'dotDotDash'	Dot-dot-dash line	Word
'dashDotHeavy'	Heavy dot-dash line	Word
'double'	Double line	Word
'none'	Do not use underlining	All output types
'single'	Single line	All output types
'thick'	Thick line	Word
'wave'	Wavy line	Word
'waveyDouble'	Double wavy line	Word
'waveyHeavy'	Heavy wavy	Word
'words'	Underline non-space characters only	Word

If this property is empty and StyleName property of this document element specifies a style sheet style, the type of underline is determined by that style.

To specify the color as well as the type of the underline, do not set the Underline property. Instead, set the Style property of this document element to include an mlreportgen.dom.Underline format object that specifies the desired underline type and color.

Setting the Underline property adds a corresponding mlreportgen.dom.Underline format object to the Style property for this document element. Removing the Underline property setting removes the object.

WhiteSpace — White space and line breaks in text

[] (default) | character vector

To specify how to handle white space, use one of these values. The WhiteSpace property does not apply to PDF format for Text objects.

Value	Description	Supported 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
'preserve'	Preserves white space. Text wraps when necessary and on line breaks. Acts like the <pre-wrap> setting in HTML.	Word and HTML See below for details.
'pre'	Preserves white space. Text wraps only on line breaks. Acts like the <pre> setting in HTML.	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 rather than the pre setting.

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

Methods

Use the Text.append and Text.clone methods the same way you use the Paragraph.append and Paragraph.clone methods.

Method	Purpose
append	Append a custom element to this text object.
clone	Clone this text object