mlreportgen.ppt.TextBoxPlaceholder 类

命名空间: mlreportgen.ppt

幻灯片标题的占位符

描述

mlreportgen.ppt.TextBoxPlaceholder 类的对象是幻灯片标题的占位符。当您向演示文稿中添加带有标题的幻灯片时，PPT API 会为标题创建一个 TextBoxPlaceholder 对象。默认 PPT API 中的所有幻灯片布局（除 Blank 之外）都有标题。要查找 TextBoxPlaceholder 对象，请使用包含标题的幻灯片的 find 方法。然后，您可以设置 TextBoxPlaceholder 对象的属性来指定替换占位符内容的标题文本的默认格式。要用标题文本替换占位符内容，请使用 TextBoxPlaceholder 对象的 replace 方法。replace 方法不会替换 TextBoxPlaceholder 对象。它将文本作为一个或多个段落添加到 TextBoxPlaceholder 对象的 Children 属性。

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

类属性

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

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

属性

全部展开

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

是否对文本使用粗体，指定为 true 或 false。指定 true 表示粗体文本。

数据类型: logical

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

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

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

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

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

文本的字体颜色，指定为由 CSS 颜色名称或十六进制 RGB 值组成的字符向量或字符串标量。

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

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

文本的字体大小，指定为由数字和测量单位组成的字符向量或字符串标量。例如，'11pt' 指定 11 个点。有效的缩写是：

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

数据类型: char | string

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

是否对文本使用斜体，指定为 true 或 false。指定 true 表示斜体文本。

数据类型: logical

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

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

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

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

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

数据类型: logical

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

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

数据类型: logical

`Underline` — 文本下划线样式
`[]` (默认) | `'single'` | `'double'` | ...

文本的下划线样式，指定为以下值之一：

值	描述
`"single"`	单下划线
`"double"`	双下划线
`"heavy"`	粗下划线
`"words"`	仅对单词加下划线（不包括空格）
`"dotted"`	点线下划线
`"dottedheavy"`	粗点线下划线
`"dash"`	虚线下划线
`"dashheavy"`	粗虚线下划线
`"dashlong"`	长虚线下划线
`"dashlongheavy"`	粗长虚线下划线
`"dotdash"`	点划线下划线
`"dotdashheavy"`	粗点划线下划线
`"dotdotdash"`	双点划线下划线
`"dotdotdashheavy"`	粗双点划线下划线
`"wavy"`	波浪下划线
`"wavyheavy"`	粗波浪下划线
`"wavydouble"`	双波浪下划线
`"none"`	无下划线

`BackgroundColor` — 文本框占位符的背景颜色
`[]` (默认) | 字符向量 | 字符串标量

文本框占位符的背景颜色，指定为由 CSS 颜色名称或十六进制 RGB 值组成的字符向量或字符串标量。

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

`VAlign` — 文本框占位符中的文本垂直对齐方式
`[]` (默认) | `'top'` | `'bottom'` | ...

文本框占位符中标题文本的垂直对齐方式，指定为字符向量或字符串标量。指定表中的一个值。

值	描述
`'top'`	垂直对齐至顶部
`'bottom'`	垂直对齐到表条目的底部
`'middle'`	垂直对齐到表条目的中间
`'topCentered'`	垂直对齐到表条目的顶部，水平对齐到表条目的中心
`'bottomCentered'`	垂直对齐到表条目的底部，水平对齐到表条目的中心
`'middleCentered'`	垂直对齐到中间，水平对齐到表条目的中心

`Name` — 文本框占位符名称
字符向量 | 字符串标量

文本框占位符名称，指定为字符向量或字符串标量。

`X` — 左上角 x 坐标位置
字符向量 | 字符串标量

左上角 x 坐标位置，指定为字符向量或字符串标量，由数字和后跟测量单位缩写组成。例如，“5in”表示五英寸。有效的缩写是：

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

属性：

NonCopyable true

数据类型: char | string

`Y` — 左上角 y 坐标位置
字符向量 | 字符串标量

左上角 y 坐标位置，指定为字符向量或字符串标量，由数字和后跟测量单位缩写组成。例如，“5in”表示五英寸。有效的缩写是：

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

属性：

NonCopyable true

数据类型: char | string

`Width` — 文本框占位符的宽度
字符向量 | 字符串标量

文本框占位符的宽度，指定为字符向量或字符串标量，由数字和后跟测量单位的缩写组成。例如，“5in”表示五英寸。有效的缩写是：

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

`Height` — 文本框占位符的高度
字符向量 | 字符串标量

文本框占位符的高度，指定为字符向量或字符串标量，由数字和后跟测量单位的缩写组成。例如，“5in”表示五英寸。有效的缩写是：

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

`Style` — 文本框占位符格式
PPT 格式对象的元胞数组

文本框占位符格式，指定为 PPT 格式对象的元胞数组。不适用于 TextBoxPlaceholder 对象的格式将被忽略。

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

import mlreportgen.ppt.*
slide = add(ppt,"Title Slide");
content = find(slide,"Title");
placeholderObj = content(1);
placeholderObj.Style = [placeholderObj.Style {Bold(true),FontColor("red")}];
replace(placeholderObj,'Test');

请参阅演示格式化方法。

`Children` — 此 PPT API 对象的子项
PPT API 对象的元胞数组

此 PPT API 对象的子元素，指定为 PPT API 对象的元胞数组。

属性：

NonCopyable true

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

该对象的父级，指定为 PPT 对象。

属性：

`SetAccess`	`private`
`NonCopyable`	`true`

`Id` — 此 PPT API 对象的 ID
字符向量 | 字符串标量

此 PPT API 对象的 ID，指定为字符向量或字符串标量。会话唯一 ID 是在对象创建过程中生成的。您可以指定一个 ID 来替换生成的 ID。

属性：

NonCopyable true

数据类型: char | string

`Tag` — 此 PPT API 对象的标签
字符向量 | 字符串标量

此 PPT API 对象的标签，指定为字符向量或字符串标量。在创建此对象的过程中会生成一个会话唯一标签。生成的标签形式为 CLASS:ID，其中 CLASS 是对象类，ID 是对象的 Id 属性的值。

指定您自己的标签值可以帮助您识别演示文稿生成过程中出现问题的位置。

属性：

NonCopyable true

数据类型: char | string

方法

全部展开

公共方法

`add`	将内容添加到文本框占位符
`replace`	替换文本框占位符内容

示例

全部折叠

替换占位符中的标题文本

打开实时脚本

向演示文稿添加标题幻灯片，然后用标题和副标题文本替换标题和副标题的幻灯片占位符。

导入 PPT 命名空间，这样您就不必对 PPT API 类使用长而完全限定的名称。

import mlreportgen.ppt.*

创建演示文稿。

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

添加标题幻灯片。

slide = add(ppt,"Title Slide");

使用幻灯片对象的 find 方法查找名为 Title 的占位符对象。

titlePlaceholderObj = find(slide,"Title")

titlePlaceholderObj = 
  TextBoxPlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Title'
                    X: '1524000emu'
                    Y: '1122363emu'
                Width: '9144000emu'
               Height: '2387600emu'
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TextBoxPlaceholder:431:407'
                   Id: '431:407'

find 方法返回一个 mlreportgen.ppt.TextBoxPlaceholder 对象。

用标题文本替换占位符内容。

replace(titlePlaceholderObj(1),"My Title");

找到字幕的占位符对象。

subtitlePlaceholderObj = find(slide,"Subtitle")

subtitlePlaceholderObj = 
  TextBoxPlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Subtitle'
                    X: '1524000emu'
                    Y: '3602038emu'
                Width: '9144000emu'
               Height: '1655762emu'
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TextBoxPlaceholder:432:408'
                   Id: '432:408'

字幕的占位符对象也是一个 mlreportgen.ppt.TextBoxPlaceholder 对象。

将占位符内容替换为字幕文本。

replace(subtitlePlaceholderObj(1),"My Subtitle");

关闭并查看演示文稿。

close(ppt);
rptview(ppt);

这是生成的演示文稿中的标题幻灯片：

将段落添加到幻灯片标题

打开实时脚本

要向幻灯片标题添加段落，请使用代表标题的 TextBoxPlaceholder 对象的 add 方法。此示例创建一个带有 Title and Table 幻灯片的演示文稿，然后根据第一个演示文稿创建第二个演示文稿。在第二个演示文稿中，示例将内容添加到 Title and Table 幻灯片的标题中。

导入 PPT 命名空间，这样您就不必对 PPT API 类使用长而完全限定的名称。

import mlreportgen.ppt.*

创建演示文稿并向演示文稿添加 Title and Table 幻灯片。

ppt = Presentation("myPPT1.pptx");
open(ppt);
slide = add(ppt,"Title and Table");

找到标题的文本框占位符并替换内容。

contents = find(slide,"Title");
replace(contents(1),"Hello World");

关闭并生成演示文稿。

close(ppt);

这是生成的演示文稿中的标题幻灯片：

使用第一个演示文稿作为模板，创建第二个演示文稿。

ppt = Presentation("myPPT2.pptx","myPPT1.pptx");
open(ppt);

找到标题的文本框占位符并向标题添加内容。

contents = find(ppt,"Title");
add(contents(1)," -- How are You?");

关闭并查看演示文稿。

close(ppt);
rptview(ppt)

在第二个演示文稿中，标题包含来自模板演示文稿的内容和添加的内容。

提示

如果您添加的幻灯片布局中包含非标题文本的占位符，则 PPT API 会创建 mlreportgen.ppt.BodyPlaceholder 或 mlreportgen.ppt.ContentPlaceholder 对象。

要查看 PPT API 为幻灯片对象创建的占位符对象，请查看幻灯片的 Children 属性。例如，当您向演示文稿添加 Title and Content 幻灯片时，Children 属性是一个包含 mlreportgen.ppt.TextBoxPlaceholder 对象和 mlreportgen.ppt.ContentPlaceholder 对象的数组。

ppt = mlreportgen.ppt.Presentation("test.pptx");
open(ppt);
slide = add(ppt,"Title and Content");
slide.Children(1)

ans = 

  TextBoxPlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Title'
                    X: []
                    Y: []
                Width: []
               Height: []
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.TextBoxPlaceholder:6:11'
                   Id: '6:11'

slide.Children(2)

ans = 

  ContentPlaceholder with properties:

                 Bold: []
                 Font: []
    ComplexScriptFont: []
            FontColor: []
             FontSize: []
               Italic: []
               Strike: []
            Subscript: []
          Superscript: []
            Underline: []
      BackgroundColor: []
               VAlign: []
                 Name: 'Content'
                    X: []
                    Y: []
                Width: []
               Height: []
                Style: []
             Children: []
               Parent: [1×1 mlreportgen.ppt.Slide]
                  Tag: 'ppt.ContentPlaceholder:7:12'
                   Id: '7:12'

版本历史记录

在 R2015b 中推出

另请参阅

mlreportgen.ppt.Paragraph | mlreportgen.ppt.PicturePlaceholder | mlreportgen.ppt.TablePlaceholder | mlreportgen.ppt.ContentPlaceholder | getLayoutNames

mlreportgen.ppt.TextBoxPlaceholder 类

描述

类属性

属性

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

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

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

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

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

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

Strike — 文本删除线样式 [] (默认) | 'single' | 'none' | 'double'

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

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

Underline — 文本下划线样式 [] (默认) | 'single' | 'double' | ...

BackgroundColor — 文本框占位符的背景颜色 [] (默认) | 字符向量 | 字符串标量

VAlign — 文本框占位符中的文本垂直对齐方式 [] (默认) | 'top' | 'bottom' | ...

Name — 文本框占位符名称 字符向量 | 字符串标量

X — 左上角 x 坐标位置 字符向量 | 字符串标量

属性：

Y — 左上角 y 坐标位置 字符向量 | 字符串标量

属性：

Width — 文本框占位符的宽度 字符向量 | 字符串标量

Height — 文本框占位符的高度 字符向量 | 字符串标量

Style — 文本框占位符格式 PPT 格式对象的元胞数组

Children — 此 PPT API 对象的子项 PPT API 对象的元胞数组

属性：

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

属性：

Id — 此 PPT API 对象的 ID 字符向量 | 字符串标量

属性：

Tag — 此 PPT API 对象的标签 字符向量 | 字符串标量

属性：

方法

公共方法

示例

替换占位符中的标题文本

将段落添加到幻灯片标题

提示

版本历史记录

另请参阅

主题

WeChat

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

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

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

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

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

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

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

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

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

`Underline` — 文本下划线样式
`[]` (默认) | `'single'` | `'double'` | ...

`BackgroundColor` — 文本框占位符的背景颜色
`[]` (默认) | 字符向量 | 字符串标量

`VAlign` — 文本框占位符中的文本垂直对齐方式
`[]` (默认) | `'top'` | `'bottom'` | ...

`Name` — 文本框占位符名称
字符向量 | 字符串标量

`X` — 左上角 x 坐标位置
字符向量 | 字符串标量

`Y` — 左上角 y 坐标位置
字符向量 | 字符串标量

`Width` — 文本框占位符的宽度
字符向量 | 字符串标量

`Height` — 文本框占位符的高度
字符向量 | 字符串标量

`Style` — 文本框占位符格式
PPT 格式对象的元胞数组

`Children` — 此 PPT API 对象的子项
PPT API 对象的元胞数组

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

`Id` — 此 PPT API 对象的 ID
字符向量 | 字符串标量

`Tag` — 此 PPT API 对象的标签
字符向量 | 字符串标量