Main Content

mlreportgen.ppt.Underline Class

Namespace: mlreportgen.ppt

Underline text

expand all in page

Description

Format that underlines presentation text.

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

Class Attributes

HandleCompatible
true
ConstructOnLoad
true

For information on class attributes, see Class Attributes.

Creation

Description

underlineObj = mlreportgen.ppt.Underline draws a single line under text.

underlineObj = mlreportgen.ppt.Underline(style) sets the Style property to the specified underline style.

example

Properties

expand all

Underline style, specified as one of these values:

ValueDescription
"single"Single underline
"double"Double underline
"heavy"Thick underline
"words"Only words underlined (not spaces)
"dotted"Dotted underline
"dottedheavy"Thick, dotted underline
"dash"Dashed underline
"dashheavy"Thick, dashed underline
"dashlong"Long, dashed underline
"dashlongheavy"Thick, long, dashed underline
"dotdash"Dot-dash underline
"dotdashheavy"Thick, dot-dash underline
"dotdotdash"Dot-dot-dash underline
"dotdotdashheavy"Thick, dot-dot-dash underline
"wavy"Wavy underline
"wavyheavy"Thick, wavy underline
"wavydouble"Wavy, double underline
"none"No underline

Object identifier for the mlreportgen.ppt.Underline object, specified as a character vector or string scalar. The PPT 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

Tag for the mlreportgen.ppt.Underline object, specified as a character vector or string scalar. The PPT 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

Examples

collapse all

Create a presentation.

import mlreportgen.ppt.*

ppt = Presentation('myUnderlinePresentation.pptx');
open(ppt);
slide = add(ppt,'Title and Content');

Create a paragraph and append underlined text.

p = Paragraph('Hello World');

tWavy = Text(' wavy underline');
tWavy.Style = {Underline('wavy')};
append(p,tWavy);

tDashed = Text(' heavy dash underline');
tDashed.Style = {Underline('dashheavy')};
append(p,tDashed);

Add the paragraph to the slide.

replace(slide,'Content',p);

Close and view the presentation.

close(ppt);
rptview(ppt);

Presentation slide that reads " Hello World wavy underline heavy dash underline", with the text "wavy underline" displayed with a wavy underline, and the text "heavy dash underline" displaying with a heavy dash underline

Version History

Introduced in R2015b

See Also

|