mlreportgen.ppt.Text class

Package: mlreportgen.ppt
Superclasses:

Text

expand all in page

Description

Text to include in a presentation.

Construction

textObj = Text() creates an empty text object.

textObj = Text(text) creates an mlreportgen.ppt.Text object with the text specified by text.

Input Arguments

expand all

Text, specified as a character vector.

Output Arguments

expand all

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

Properties

expand all

Text content, specified as a character vector.

Option to use bold for text, specified as a logical. To make text bold, set this property to true or 1. Setting the Bold property adds a corresponding mlreportgen.ppt.Bold format object to the Style property of this presentation element. Removing the Bold property setting removes the object.

Data Types: logical

Default font for text in column, specified as a character vector. Specify a font that appears in the PowerPoint® list of fonts in the Home tab Font area.

Font family for complex scripts, specified as a character vector. Specify a font family for substituting in a locale that requires a complex script (such as Arabic or Asian) for rendering text.

Font size, specified as a character vector. Use the format valueUnits, where Units is an abbreviation for the font size. These abbreviations are valid:

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

Font color, specified as a character vector. Use either a CSS color name or a hexadecimal RGB value.

  • For a list of CSS color names, see https://www.crockford.com/wrrrld/color.html.

  • To specify a hexadecimal RGB format, use # as the first character and two-digit hexadecimal numbers for each for the red, green, and blue values. For example, '#0000ff' specifies blue.

Option to use italics for text, specified as a logical. Set this property to true. Setting the Italic property adds a corresponding mlreportgen.ppt.Italic format object to the Style property of this presentation element. Removing the Italic property setting removes the object.

Data Types: logical

Format text as subscript, specifying as a logical value. A value of true renders the text as a subscript.

Format text as superscript, specifying as a logical value. A value of true renders the text as a superscript.

Type of underlining for text, specified as a character vector. Setting the Underline property adds a corresponding mlreportgen.ppt.Underline format object to the Style property for this element. Removing the Underline property setting removes the object. You can specify one of these types of underlines.

ValueDescription
'single'Single underline
'double'Double underline
'heavy'Thick underline
'words'Words only 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
'dotdotdash'Dot dot dash underline
'dotdotdashheavy'Thick dot dot dash underline
'dotdashdotheavy'Thick dash dot underline
'wavy'Wavy underline
'wavyheavy'Thick wavy underline
'wavydouble'Two wavy underlines

Strike type, specified as one of these values:

  • 'single' — Single horizontal line (default)

  • 'none' — No strikethrough line

  • 'double' — Double horizontal line

Text formatting, specified as a cell array of PPT format objects. You can specify these mlreportgen.ppt format objects:

  • FontFamily object

  • FontSize object

  • Bold object

  • FontColor object

  • Italic object

  • Underline object

Child elements of this object, specified as a cell array of PPT objects. This property is read-only.

Parent of this object, specified as a PPT object. This property is read-only.

Tag for this PPT API object, specified as a character vector. 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.

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

Examples

collapse all

Create a presentation with two slides.

import mlreportgen.ppt.*

slidesFile = 'myTextPresentation.pptx';
slides = Presentation(slidesFile);

add(slides,'Title Slide');
add(slides,'Title and Content');

Create a Paragraph object to use for the title of the presentation. Make the text bold and red.

p = Paragraph();
p.Bold = true;
p.FontColor = 'red';

Create a Text object and append it to the paragraph.

titleText = Text('My Presentation Title');
append(p,titleText);

Replace the title for the first slide with the paragraph.

contents = find(slides,'Title');
replace(contents(1),p);

Create a paragraph for the content of the second slide.

p1 = Paragraph('My content');
append(p1,Text(' for the second slide'));

Replace the content with the p1 paragraph.

replace(slides,'Content',p1);

Close the presentation.

close(slides);

Open myParagraphPresentation.pptx. On a Windows® platform, you can open the presentation in MATLAB®:

if ispc
    winopen(slidesFile);
end

See Also

| |

Topics

MATLAB Report Generator Documentation
Support

Try MATLAB, Simulink, and Other Products

Get trial now