mlreportgen.dom.Underline Class

Namespace: mlreportgen.dom

Draw line under text

Description

Draw line under text

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

Creation

Description

underline = Underline draws a single line under text.

underline = Underline(type) draws a line of the specified type under the text.

underline = Underline(type,color) draws a line of the specified type and color under the text. The color parameter must be an mlreportgen.dom.Color object.

Input Arguments

type — Style of underline

character vector

Style of the underline, specified as one of these values. HTML and PDF support only "single".

Value	Description
"single"	Single underline (only style supported for HTML and PDF)
"double"	Double underline
"words"	Words only underlined (not spaces)
"thick"	Thick underline
"dotted"	Dotted underline
"dottedHeavy"	Thick, dotted underline
"dash"	Dashed underline
"dashedHeavy"	Thick, dashed underline
"dashLong"	Long, dashed underline
"dashLongHeavy"	Thick, long, dashed underline
"dotDash"	Dot dash underline
"dotDotDash"	Dash dot dot underline
"dashDotDotHeavy"	Thick dash dot dot underline
"dashDotHeavy"	Thick dash dot underline
"none"	No underline
"wave"	Wavy underline
"wavyDouble"	Two wavy underlines
"wavyHeavy"	Thick wavy underline

color — Color of underline

mlreportgen.dom.Color object

Color of the underline, specified by an mlreportgen.dom.Color object.

Properties

Type — Underline style

character vector

Underline style. See the description of the type input argument for the constructor.

Data Types: char

Color — Color of underline

mlreportgen.dom.Color object

Color of the underline, specified by an mlreportgen.dom.Color object.

Id — Object identifier

character vector | string scalar

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

Tag — Tag

character vector | string scalar

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

Version History

Introduced in R2014b