mlreportgen.ppt.ExternalLink Class

Namespace: mlreportgen.ppt
Superclasses: mlreportgen.ppt.Text

Hyperlink to location outside of presentation

Description

Use an object of the mlreportgen.ppt.ExternalLink class to define a hyperlink to a location outside of the presentation.

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

Class Attributes

`HandleCompatible`	`true`
`ConstructOnLoad`	`true`

For information on class attributes, see Class Attributes.

Creation

Description

externalLinkObj = ExternalLink creates an empty mlreportgen.ppt.ExternalLink object.

externalLinkObj = ExternalLink(target,linkText) creates an mlreportgen.ppt.ExternalLink object with the Target property set to target and the Content property to linkText.

example

Properties

expand all

`Target` — Target URL of link
`""` (default) | character vector | string scalar

Target URL of link, specified as a character vector or a string scalar.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`Content` — Link text
`""` (default) | character vector | string scalar

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

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: char | string

`Bold` — Whether to use bold for link text
`[]` (default) | `1` (`true`) | `0` (`false`)

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

1 (true) — Render link text in bold.
0 (false) — Render link text in regular weight.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: logical

`Font` — Font family for link text
`[]` (default) | character vector | string scalar

Font family for the link 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`

`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 link text
`[]` (default) | character vector | string scalar

Font color for the link 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 for link text
`[]` (default) | character vector | string scalar

Font size for the link 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

`Italic` — Whether to use italic for link text
`[]` (default) | `1` (`true`) | `0` (`false`)

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

1 (true) — Render link text in italic.
0 (false) — Render link text as straight text.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: logical

`Strike` — Strikethrough style for link text
`[]` (default) | `"single"` | `"none"` | `"double"`

Strikethrough style for the link 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`

`Subscript` — Whether to display link text as a subscript
`[]` (default) | `1` (`true`) | `0` (`false`)

Whether to display the link text as a subscript, specified as a logical 1 (true) or 0 (false). When you specify:

1 (true) — Render link text as a superscript.
0 (false) — Render link text as regular text.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: logical

`Superscript` — Whether to display link text as a superscript
`[]` (default) | `1` (`true`) | `0` (`false`)

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

1 (true) — Render link text as a superscript.
0 (false) — Render link text as regular text.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

Data Types: logical

`Underline` — This property is ignored
`[]` (default)

This property is ignored.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Style` — Link text formatting
`[]` (default) | cell array of PPT format objects

Link text 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:

link = mlreportgen.ppt.ExternalLink(3,"link text");
link.Style = [link.Style {Bold(true)}];

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` — This property is ignored
not applicable

The class ignores this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`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

expand all

Public Methods

clone

objCopy = clone(obj) returns a copy of the mlreportgen.ppt.ExternalLink object specified by obj. The copy includes the children of the source object, but not the parent.

Input Arguments

obj — Object to clone, specified as an mlreportgen.ppt.ExternalLink object

Return Values

objCopy— Object copy, returned as an mlreportgen.ppt.ExternalLink object

For more information, see the method for the mlreportgen.ppt.Paragraph class, clone.

Examples

collapse all

Add an External Link to a Presentation

Open Live Script

Create a presentation that includes a link to a web site.

Create a presentation.

import mlreportgen.ppt.*
ppt = Presentation("myExternalLinkPresentation.pptx");
open(ppt);

Add a slide to the presentation.

slide = add(ppt,"Title and Content");

Create an mlreportgen.ppt.Paragraph object.

p = Paragraph("This is a link to the ");

Create an mlreportgen.ppt.ExternalLink object and append it to the paragraph.

link = ExternalLink("https://www.mathworks.com","MathWorks site");
append(p,link);

Replace the slide content with the paragraph.

replace(slide,"Content",p);

Close and view the presentation.

close(ppt);
rptview(ppt);

Here is the link in the generated slide.

Version History

Introduced in R2015b

mlreportgen.ppt.ExternalLink Class

Description

Class Attributes

Creation

Description

Properties

Target — Target URL of link "" (default) | character vector | string scalar

Attributes:

Content — Link text "" (default) | character vector | string scalar

Attributes:

Bold — Whether to use bold for link text [] (default) | 1 (true) | 0 (false)

Attributes:

Font — Font family for link text [] (default) | character vector | string scalar

Attributes:

ComplexScriptFont — Font family for complex scripts [] (default) | character vector | string scalar

Attributes:

FontColor — Font color for link text [] (default) | character vector | string scalar

Attributes:

FontSize — Font size for link text [] (default) | character vector | string scalar

Attributes:

Italic — Whether to use italic for link text [] (default) | 1 (true) | 0 (false)

Attributes:

Strike — Strikethrough style for link text [] (default) | "single" | "none" | "double"

Attributes:

Subscript — Whether to display link text as a subscript [] (default) | 1 (true) | 0 (false)

Attributes:

Superscript — Whether to display link text as a superscript [] (default) | 1 (true) | 0 (false)

Attributes:

Underline — This property is ignored [] (default)

Attributes:

Style — Link text formatting [] (default) | cell array of PPT format objects

Attributes:

Parent — Parent of this object PPT API object

Attributes:

Children — This property is ignored not applicable

Attributes:

Tag — Tag character vector | string scalar

Attributes:

Id — Object identifier character vector | string scalar

Attributes:

Methods

Public Methods

Examples

Add an External Link to a Presentation

Version History

See Also

Topics

`Target` — Target URL of link
`""` (default) | character vector | string scalar

`Content` — Link text
`""` (default) | character vector | string scalar

`Bold` — Whether to use bold for link text
`[]` (default) | `1` (`true`) | `0` (`false`)

`Font` — Font family for link text
`[]` (default) | character vector | string scalar

`ComplexScriptFont` — Font family for complex scripts
`[]` (default) | character vector | string scalar

`FontColor` — Font color for link text
`[]` (default) | character vector | string scalar

`FontSize` — Font size for link text
`[]` (default) | character vector | string scalar

`Italic` — Whether to use italic for link text
`[]` (default) | `1` (`true`) | `0` (`false`)

`Strike` — Strikethrough style for link text
`[]` (default) | `"single"` | `"none"` | `"double"`

`Subscript` — Whether to display link text as a subscript
`[]` (default) | `1` (`true`) | `0` (`false`)

`Superscript` — Whether to display link text as a superscript
`[]` (default) | `1` (`true`) | `0` (`false`)

`Underline` — This property is ignored
`[]` (default)

`Style` — Link text formatting
`[]` (default) | cell array of PPT format objects

`Parent` — Parent of this object
PPT API object

`Children` — This property is ignored
not applicable

`Tag` — Tag
character vector | string scalar

`Id` — Object identifier
character vector | string scalar