mlreportgen.ppt.Paragraph Class

Namespace: mlreportgen.ppt

Formatted block of text (paragraph)

Description

Use an object of the mlreportgen.ppt.Paragraph class to include a paragraph in a PPT API presentation. A paragraph can contain text or mlreportgen.ppt.Text, mlreportgen.ppt.InternalLink, or mlreportgen.ppt.ExternalLink objects.

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

Class Attributes

HandleCompatible	true
ConstructOnLoad	true

For information on class attributes, see Class Attributes.

Creation

Description

paragraphObj = mlreportgen.ppt.Paragraph creates an empty paragraph object.

paragraphObj = mlreportgen.ppt.Paragraph(text) creates a paragraph that contains an mlreportgen.ppt.Text object with the text specified by text.

paragraphObj = mlreportgen.ppt.Paragraph(pptElementObj) creates a paragraph that contains the text, internal link, or external link specified by pptElementObj.

Input Arguments

text — Paragraph text

character vector | string scalar

Paragraph text, specified as a character vector or string scalar.

pptElementObj — Presentation element to include in paragraph

mlreportgen.ppt.Text object | mlreportgen.ppt.InternalLink | mlreportgen.ppt.ExternalLink object

Presentation element to include in the paragraph, specified as an mlreportgen.ppt.Text, mlreportgen.ppt.InternalLink, or mlreportgen.ppt.ExternalLink object.

Properties

Font — Font family for text

[] (default) | character vector | string scalar

Font family for the text, specified as a character vector or string scalar. Specify a font that appears in the font list in Microsoft^® PowerPoint^®. To see the font list, in PowerPoint, on the Home tab, in the Font group, click the arrow to the right of the font.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

ComplexScriptFont — Font family for complex scripts

[] (default) | character vector | string scalar

Font family for complex scripts, specified as a character vector or string scalar. Specify a font family to use when substituting in a locale that requires a complex script, such as Arabic or Asian, to render text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

FontColor — Font color for text

[] (default) | character vector | string scalar

Font color for the text, specified as a character vector or string scalar that contains a CSS color name or hexadecimal RGB value.

Format	Value
CSS color name	Specify a CSS color name. For a list of CSS color names, see https://www.w3.org/wiki/CSS/Properties/color/keywords.
Hexadecimal RGB value	Use the format "#RRGGBB". Use # as the first character and two-digit hexadecimal numbers for the red, green, and blue values. You can use uppercase or lowercase letters.

Example: "red" specifies a red color using a CSS color name.

Example: "#0000ff" specifies a blue color using a hexadecimal RGB value.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

FontSize — Font size of text

[] (default) | character vector | string scalar

Font size of the text, specified as a character vector or string scalar that contains a number followed by a unit of measurement. For example, "11pt" specifies 11 points. Valid abbreviations are:

• "px" — Pixels

• "cm" — Centimeters

• "in" — Inches

• "mm" — Millimeters

• "pc" — Picas

• "pt" — Points

You can also specify pixels by omitting the unit. For example, "5" specifies 5 pixels.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Bold — Whether to use bold for text

[] (default) | 1 (true) | 0 (false)

Whether to use bold for the text, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Render text in bold.

• 0 (false) — Render text in regular weight.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Italic — Whether to use italic for text

[] (default) | 1 (true) | 0 (false)

Whether to use italic for the text, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Render text in italic.

• 0 (false) — Render text as straight text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Strike — Strikethrough style for text

[] (default) | "single" | "none" | "double"

Strikethrough style for the text, specified as one of these values:

• "single" — Single horizontal line

• "none" —No strikethrough line

• "double" — Double horizontal line

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Subscript — Whether to display text as a subscript

[] (default) | 1 (true) | 0 (false)

Whether to display the text as a subscript, specified as a logical 1 (true) or 0 (false). When you specify:. If Subscript is 1 (true), text renders as a subscript. If Subscript is 0 (false), text renders as regular text.

• 1 (true) — Render text as a subscript.

• 0 (false) — Render text in regular text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Superscript — Whether to display document element as superscript

[] (default) | 1 (true) | 0 (false)

Whether to display the document element as a superscript, specified as a logical 1 (true) or 0 (false). When you specify:

• 1 (true) — Render document element as a superscript.

• 0 (false) — Render document element in regular text.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: logical

Underline — Underline style for text

[] (default) | "single" | "double" | ... | ...

Underline style for the text, 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

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

HAlign — Horizontal alignment of text

[] | "center" | "distribute" | ...

Horizontal alignment of the text in this paragraph, specified as one of these values:

Value	Description
"center"	Centered
"left"	Left-justified
"right"	Right-justified
"justified"	Left and right-justified, spacing words evenly
"distributed"	Left and right-justified, spacing letters evenly
"thaiDistributed"	Left and right-justified Thai text, spacing characters evenly
"justifiedLow"	Justification for Arabic text

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Level — Indentation level of paragraph

[] (default) | integer in the range [1,9]

Indentation level of this paragraph, specified as an integer in the range [1,9]. The value 1 indicates a top-level paragraph with no indentation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Style — Paragraph formatting

cell array of PPT format objects

Paragraph formatting, specified as a cell array of PPT format objects.

Add format objects by concatenating the existing value of the Style property with a cell array that contains the format objects that you are adding. For example:

para = mlreportgen.ppt.Paragraph("my paragraph");
para.Style = [para.Style {Bold(true),FontColor("red")}];

See Presentation Formatting Approaches.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: cell

Parent — Parent of this object

PPT API object

Parent of this object, specified as a PPT API object. A PPT API object must only have one parent.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — Children of this object

cell array of PPT API objects

Child elements of this object, specified as a cell array of PPT API objects.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Data Types: cell

Tag — Tag

character vector | string scalar

Tag, 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. Use this value to help identify where an issue occurs during presentation generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The PPT API generates a session-unique identifier when it creates the presentation element object. You can specify your own value for Id.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public Methods

append	Append content to paragraph
clone	Copy PPT API paragraph

Examples

Add Paragraphs to Presentation Slides

Create a presentation with two slides.

import mlreportgen.ppt.*;

ppt = Presentation("myParagraphPresentation.pptx");
open(ppt);

add(ppt,"Title Slide");
add(ppt,"Title and Content");

Create an mlreportgen.ppt.Paragraph object to use for the title. Make the text bold and red.

p = Paragraph("My Title");
p.Bold = true;
p.FontColor = "red";

Replace the title for the first slide with the paragraph.

contents = find(ppt,"Title");
replace(contents(1),p);

Create a paragraph for the content of the second slide.

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

Replace the content with the p1 paragraph.

replace(ppt,"Content",p1);

Close and view the presentation.

close(ppt);
rptview(ppt);

Here are the slides in the generated presentation:

Version History

Introduced in R2015b