Main Content

mlreportgen.dom.Underline class

Package: mlreportgen.dom
Superclasses:

Draw line under text

Description

Draw line under text

Construction

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

expand all

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

ValueDescription
'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 of the underline, specified by an mlreportgen.dom.Color object.

Output Arguments

expand all

Underline, represented by an mlreportgen.dom.Underline object.

Properties

expand all

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

Data Types: char

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

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.

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.