mlreportgen.ppt.InternalLink 类

命名空间: mlreportgen.ppt
超类: mlreportgen.ppt.Text

演示文稿幻灯片的超链接

自 R2021a 起

描述

使用 mlreportgen.ppt.InternalLink 类的对象将演示文稿中的一张幻灯片链接到另一张幻灯片。

mlreportgen.ppt.InternalLink 类是一个 handle 类。

类属性

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

有关类属性的信息，请参阅类属性。

创建对象

描述

internalLinkObj = mlreportgen.ppt.InternalLink 创建一个空 InternalLink 对象。

internalLinkObj = mlreportgen.ppt.InternalLink(targetSlideName,linkText) 创建一个 InternalLink 对象，其 Target属性设置为 targetSlideName，Content属性设置为 linkText。

示例

internalLinkObj = mlreportgen.ppt.InternalLink(targetSlideIndex,linkText) 创建一个 InternalLink 对象，其 Target属性设置为 targetSlideIndex，Content属性设置为 linkText。

示例

属性

全部展开

`Target` — 超链接的目标幻灯片
`[]` (默认) | 整数 | 字符向量 | 字符串标量

超链接的目标幻灯片，指定为整数、字符向量或字符串标量。使用整数表示目标幻灯片的索引。使用字符向量或字符串标量来指示目标幻灯片的名称。

属性：

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

数据类型: char | string

`Content` — 链接文本
`""` (默认) | 字符向量 | 字符串标量

链接文本，指定为字符向量或字符串标量。

属性：

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

数据类型: char | string

`Bold` — 是否对链接文本使用粗体
`[]` (默认) | `true` | `false`

是否对链接文本使用粗体，指定为 true 或 false。true 设置将使文本以粗体呈现。

属性：

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

数据类型: logical

`Font` — 链接文本的字体系列
`[]` (默认) | 字符向量 | 字符串标量

链接文本的字体系列，指定为字符向量或字符串标量。指定 Microsoft^® PowerPoint^® 中的字体列表中出现的字体。要查看字体列表，请在 PowerPoint 的主页选项卡上的字体组中点击字体右侧的箭头。

属性：

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

`ComplexScriptFont` — 复杂脚本的字体系列
`[]` (默认) | 字符向量 | 字符串标量

复杂脚本的字体系列，指定为字符向量或字符串标量。指定在需要复杂脚本（例如阿拉伯语或亚洲语）来呈现文本的区域设置中替换时要使用的字体系列。

属性：

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

数据类型: char | string

`FontColor` — 链接文本的字体颜色
`[]` (默认) | 字符向量 | 字符串标量

链接文本的字体颜色，指定为包含 CSS 颜色名称或十六进制 RGB 值的字符向量或字符串标量。

要使用颜色名称，请指定一个 CSS 颜色名称。有关 CSS 颜色名称的列表，请参阅 https://www.w3.org/wiki/CSS/Properties/color/keywords。
要指定十六进制 RGB 格式，请使用 # 作为第一个字符，并使用两位十六进制数作为红色、绿色和蓝色值。例如，"#0000ff" 指定蓝色。

属性：

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

数据类型: char | string

`FontSize` — 链接文本的字体大小
`[]` (默认) | 字符向量 | 字符串标量

链接文本的字体大小，指定为字符向量或字符串标量，其中包含一个数值和一个度量单位。例如，"11pt" 指定 11 磅。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

属性：

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

数据类型: char | string

`Italic` — 是否使用斜体作为链接文本
`[]` (默认) | `true` | `false`

是否对链接文本使用斜体，指定为 true 或 false。true 设置将使文本以斜体显示。

属性：

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

数据类型: logical

`Strike` — 链接文本的删除线样式
`[]` (默认) | `"single"` | `"none"` | `"double"`

链接文本的删除线样式，指定为以下值之一：

"single" - 单条水平线
"none" - 没有删除线
"double" - 双水平线

属性：

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

`Subscript` — 是否将链接文本显示为下标
`[]` (默认) | `true` | `false`

是否将链接文本显示为下标，指定为 true 或 false。true 设置将文本呈现为下标。

属性：

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

数据类型: logical

`Superscript` — 是否将链接文本显示为上标
`[]` (默认) | `true` | `false`

是否将链接文本显示为上标，指定为 true 或 false。true 设置将文本呈现为上标。

属性：

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

数据类型: logical

`Underline` — 忽略此属性
`[]` (默认)

该属性被忽略。

属性：

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

`Style` — 链接文本格式
`[]` (默认) | PPT 格式对象元胞数组

链接文本格式，指定为由 PPT 格式对象组成的元胞数组。

通过将 Style 属性的现有值与包含要添加的格式对象元胞数组连接起来来添加格式对象。例如：

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

请参阅演示格式化方法。

属性：

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

数据类型: cell

`Parent` — 此对象的父对象
PPT API 对象

此对象的父级，指定为 PPT API 对象。一个 PPT API 对象只能有一个父对象。

属性：

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

`Children` — 忽略此属性
不适用

该类忽略此属性。

属性：

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

`Tag` — 标记
字符向量 | 字符串标量

标记，指定为字符向量或字符串标量。PPT API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性：

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

数据类型: char | string

`Id` — 目标标识符
字符向量 | 字符串标量

目标标识符，指定为字符向量或字符串标量。PPT API 在创建文档元素对象时会生成一个会话唯一标识符。您可以为 Id 指定自己的值。

属性：

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

数据类型: char | string

方法

全部展开

公共方法

clone

objCopy = clone(obj) 返回 obj 指定的 mlreportgen.ppt.InternalLink 对象的副本。

使用 InternalLink 对象的 clone 方法的方式与使用 Paragraph 对象的 clone 方法的方式相同。

示例

全部折叠

使用目标幻灯片名称链接到幻灯片

打开实时脚本

此示例使用指定目标幻灯片名称的 mlreportgen.ppt.InternalLink 对象链接到幻灯片。

创建演示文稿。

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

向演示文稿中添加幻灯片。

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

选择一个名称来识别目标幻灯片。

targetSlideName = "myTargetSlide";

创建一个段落。创建一个 InternalLink 对象，通过名称指定目标幻灯片并将其追加到段落。

p = Paragraph("This is a link to the slide with the name ");
linkObj = InternalLink(targetSlideName,targetSlideName);
append(p,linkObj);

将标题和内容添加到幻灯片。

replace(slide1,"Title","First slide");
replace(slide1,"Content",p);

在演示文稿中添加第二张幻灯片。

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

将目标幻灯片添加到演示文稿中。将幻灯片的 Name 属性设置为 InternalLink 对象中指定的名称。

slide3 = add(ppt,"Title and Content");
slide3.Name = targetSlideName;
replace(slide3,"Title","Third slide");
content = strcat("This is the target slide with the name ",targetSlideName);
replace(slide3,"Content",content);

关闭并查看演示文稿。

close(ppt);
rptview(ppt);

以下是生成的幻灯片：

使用目标幻灯片索引链接到幻灯片

打开实时脚本

此示例使用指定目标幻灯片编号的 mlreportgen.ppt.InternalLink 对象链接到幻灯片。

创建演示文稿。

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

向演示文稿中添加幻灯片。

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

创建一个段落。创建一个 InternalLink 对象，通过其索引指定目标幻灯片并将该对象追加到段落。

p = Paragraph("This is a link to ");
link = InternalLink(3,"slide 3");
append(p,link);

将标题和内容添加到幻灯片。

replace(slide1,"Title","First slide");
replace(slide1,"Content",p);

在演示文稿中添加幻灯片 2。

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

将目标幻灯片（幻灯片 3）添加到演示文稿中。

slide3 = add(ppt,"Title and Content");
replace(slide3,"Title","Third slide");
replace(slide3,"Content","This is the target slide");

关闭并查看演示文稿。

close(ppt);
rptview(ppt);

以下是生成的幻灯片：

版本历史记录

在 R2021a 中推出

另请参阅

mlreportgen.ppt.ExternalLink | mlreportgen.ppt.Paragraph | mlreportgen.ppt.Text

mlreportgen.ppt.InternalLink 类

描述

类属性

创建对象

描述

属性

Target — 超链接的目标幻灯片 [] (默认) | 整数 | 字符向量 | 字符串标量

属性：

Content — 链接文本 "" (默认) | 字符向量 | 字符串标量

属性：

Bold — 是否对链接文本使用粗体 [] (默认) | true | false

属性：

Font — 链接文本的字体系列 [] (默认) | 字符向量 | 字符串标量

属性：

ComplexScriptFont — 复杂脚本的字体系列 [] (默认) | 字符向量 | 字符串标量

属性：

FontColor — 链接文本的字体颜色 [] (默认) | 字符向量 | 字符串标量

属性：

FontSize — 链接文本的字体大小 [] (默认) | 字符向量 | 字符串标量

属性：

Italic — 是否使用斜体作为链接文本 [] (默认) | true | false

属性：

Strike — 链接文本的删除线样式 [] (默认) | "single" | "none" | "double"

属性：

Subscript — 是否将链接文本显示为下标 [] (默认) | true | false

属性：

Superscript — 是否将链接文本显示为上标 [] (默认) | true | false

属性：

Underline — 忽略此属性 [] (默认)

属性：

Style — 链接文本格式 [] (默认) | PPT 格式对象元胞数组

属性：

Parent — 此对象的父对象 PPT API 对象

属性：

Children — 忽略此属性 不适用

属性：

Tag — 标记 字符向量 | 字符串标量

属性：

Id — 目标标识符 字符向量 | 字符串标量

属性：

方法

公共方法

示例

使用目标幻灯片名称链接到幻灯片

使用目标幻灯片索引链接到幻灯片

版本历史记录

另请参阅

主题

`Target` — 超链接的目标幻灯片
`[]` (默认) | 整数 | 字符向量 | 字符串标量

`Content` — 链接文本
`""` (默认) | 字符向量 | 字符串标量

`Bold` — 是否对链接文本使用粗体
`[]` (默认) | `true` | `false`

`Font` — 链接文本的字体系列
`[]` (默认) | 字符向量 | 字符串标量

`ComplexScriptFont` — 复杂脚本的字体系列
`[]` (默认) | 字符向量 | 字符串标量

`FontColor` — 链接文本的字体颜色
`[]` (默认) | 字符向量 | 字符串标量

`FontSize` — 链接文本的字体大小
`[]` (默认) | 字符向量 | 字符串标量

`Italic` — 是否使用斜体作为链接文本
`[]` (默认) | `true` | `false`

`Strike` — 链接文本的删除线样式
`[]` (默认) | `"single"` | `"none"` | `"double"`

`Subscript` — 是否将链接文本显示为下标
`[]` (默认) | `true` | `false`

`Superscript` — 是否将链接文本显示为上标
`[]` (默认) | `true` | `false`

`Underline` — 忽略此属性
`[]` (默认)

`Style` — 链接文本格式
`[]` (默认) | PPT 格式对象元胞数组

`Parent` — 此对象的父对象
PPT API 对象

`Children` — 忽略此属性
不适用

`Tag` — 标记
字符向量 | 字符串标量

`Id` — 目标标识符
字符向量 | 字符串标量