mlreportgen.ppt.Underline class

Package: mlreportgen.ppt

Underline text

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.

Properties

Style — Underline style

'single' (default) | 'double' | ...

Underline style, specified as one of these values:

Value	Description
'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

Id — ID for this PPT API object

character vector | string scalar

ID for this PPT API object, specified as a character vector or string scalar. A session-unique ID is generated as part of object creation. You can specify an ID to replace the generated ID.

Tag — Tag for this PPT API object

character vector | string scalar

Tag for this PPT API object, specified as a character vector or string scalar. A session-unique tag is generated 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 presentation generation.

Examples

Underline Presentation Text

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);

Version History

Introduced in R2015b