PowerPoint.SlideLayout class
表示幻灯片的版式。
注解
使用方
- PowerPoint.Shape： getParentSlideLayout， getParentSlideLayoutOrNullObject
- PowerPoint.Slide： applyLayout， layout
- PowerPoint.SlideLayoutCollection： getItem， getItemAt， getItemOrNullObject， items
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
await PowerPoint.run(async function(context) {
// Load information about all the slide masters and associated layouts.
const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
await context.sync();
// Log the name and ID of each slide master.
for (let i = 0; i < slideMasters.items.length; i++) {
console.log("Master name: " + slideMasters.items[i].name);
console.log("Master ID: " + slideMasters.items[i].id);
// Log the name and ID of each slide layout in the slide master.
const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
for (let j = 0; j < layoutsInMaster.items.length; j++) {
console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
}
}
});
属性
| background | 获取幻灯片版式的背景。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| custom |
返回幻灯片版式中自定义 XML 部件的集合。 |
| id | 获取幻灯片版式的唯一 ID。 |
| name | 获取幻灯片版式的名称。 |
| shapes | 返回幻灯片版式中的形状集合。 |
| theme |
返回幻灯片布局的 。 |
| type | 返回幻灯片版式的类型。 |
方法
| delete() | 从演示文稿中删除幻灯片版式。 如果幻灯片版式不存在，则不执行任何操作。 如果正在使用幻灯片版式，则引发 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
background
获取幻灯片版式的背景。
readonly background: PowerPoint.SlideLayoutBackground;属性值
注解
context
customXmlParts
返回幻灯片版式中自定义 XML 部件的集合。
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;属性值
注解
id
获取幻灯片版式的唯一 ID。
readonly id: string;属性值
string
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
await PowerPoint.run(async function(context) {
// Load information about all the slide masters and associated layouts.
const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
await context.sync();
// Log the name and ID of each slide master.
for (let i = 0; i < slideMasters.items.length; i++) {
console.log("Master name: " + slideMasters.items[i].name);
console.log("Master ID: " + slideMasters.items[i].id);
// Log the name and ID of each slide layout in the slide master.
const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
for (let j = 0; j < layoutsInMaster.items.length; j++) {
console.log(" Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
}
}
});
name
shapes
返回幻灯片版式中的形状集合。
readonly shapes: PowerPoint.ShapeCollection;属性值
注解
themeColorScheme
返回幻灯片布局的 。ThemeColorScheme
readonly themeColorScheme: PowerPoint.ThemeColorScheme;属性值
注解
type
返回幻灯片版式的类型。
readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";属性值
PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart"
注解
方法详细信息
delete()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
从演示文稿中删除幻灯片版式。 如果幻灯片版式不存在，则不执行任何操作。 如果正在使用幻灯片版式，则引发 GeneralException 错误。
delete(): void;返回
void
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): PowerPoint.SlideLayout;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.SlideLayout;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.SlideLayout 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 PowerPoint.Interfaces.SlideLayoutData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): PowerPoint.Interfaces.SlideLayoutData;