-
Notifications
You must be signed in to change notification settings - Fork 64
/
powerpoint.addslideoptions.yml
70 lines (59 loc) · 2.63 KB
/
powerpoint.addslideoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
### YamlMime:TSType
name: PowerPoint.AddSlideOptions
uid: 'powerpoint!PowerPoint.AddSlideOptions:interface'
package: powerpoint!
fullName: PowerPoint.AddSlideOptions
summary: Represents the available options when adding a new slide.
remarks: >-
\[ [API set: PowerPointApi 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;
await PowerPoint.run(async function(context) {
// Create a new slide using an existing master slide and layout.
const newSlideOptions: PowerPoint.AddSlideOptions = {
slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
};
context.presentation.slides.add(newSlideOptions);
await context.sync();
});
```
isPreview: false
isDeprecated: false
type: interface
properties:
- name: layoutId
uid: 'powerpoint!PowerPoint.AddSlideOptions#layoutId:member'
package: powerpoint!
fullName: layoutId
summary: >-
Specifies the ID of a Slide Layout to be used for the new slide. If no `layoutId` is provided, but a
`slideMasterId` is provided, then the ID of the first layout from the specified Slide Master will be used. If no
`slideMasterId` is provided, but a `layoutId` is provided, then the specified layout needs to be available for the
default Slide Master (as specified in the `slideMasterId` description). Otherwise, an error will be thrown.
remarks: '\[ [API set: PowerPointApi 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'layoutId?: string;'
return:
type: string
- name: slideMasterId
uid: 'powerpoint!PowerPoint.AddSlideOptions#slideMasterId:member'
package: powerpoint!
fullName: slideMasterId
summary: >-
Specifies the ID of a Slide Master to be used for the new slide. If no `slideMasterId` is provided, then the
previous slide's Slide Master will be used. If there is no previous slide, then the presentation's first Slide
Master will be used.
remarks: '\[ [API set: PowerPointApi 1.3](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'slideMasterId?: string;'
return:
type: string