PowerPoint.Slide class
Stellt eine einzelne Folie einer Präsentation dar.
- Extends
Hinweise
[ API-Satz: PowerPointApi 1.2 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
await context.sync();
slide1.setSelectedShapes(savedShapeSelection);
await context.sync();
});
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| custom |
Gibt eine Auflistung von benutzerdefinierten XML-Teilen auf der Folie zurück. |
| hyperlinks | Gibt eine Auflistung von Links auf der Folie zurück. |
| id | Ruft die eindeutige ID der Folie ab. |
| index | Gibt den nullbasierten Index der Folie zurück, die ihre Position in der Präsentation darstellt. |
| layout | Ruft das Layout der Folie ab. |
| shapes | Gibt eine Auflistung von Formen auf der Folie zurück. |
| slide |
Ruft das |
| tags | Gibt eine Auflistung von Tags auf der Folie zurück. |
Methoden
| apply |
Wendet das angegebene Layout auf die Folie an und ändert deren Design und Struktur entsprechend dem ausgewählten Layout. |
| delete() | Löscht die Folie aus der Präsentation. Tut nichts, wenn die Folie nicht vorhanden ist. |
| export |
Exportiert die Folie in eine eigene Präsentationsdatei, die als Base64-codierte Daten zurückgegeben wird. Hinweis: Diese Methode ist für den Export einer einzelnen Folie optimiert. Das Exportieren mehrerer Folien kann sich auf die Leistung auswirken. |
| get |
Rendert ein Bild der Folie. Das Bild wird so skaliert, dass es in die gewünschten Dimensionen passt. Wenn Breite und Höhe nicht angegeben sind, wird die tatsächliche Größe der Folie verwendet. Wenn nur eine breite oder höhe angegeben ist, wird die andere berechnet, um das Seitenverhältnis beizubehalten. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| move |
Verschiebt die Folie an eine neue Position innerhalb der Präsentation. |
| set |
Wählt die angegebenen Formen aus. Vorhandene Shape-Auswahl wird durch die neue Auswahl ersetzt. |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
customXmlParts
Gibt eine Auflistung von benutzerdefinierten XML-Teilen auf der Folie zurück.
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;Eigenschaftswert
Hinweise
hyperlinks
Gibt eine Auflistung von Links auf der Folie zurück.
readonly hyperlinks: PowerPoint.HyperlinkCollection;Eigenschaftswert
Hinweise
id
Ruft die eindeutige ID der Folie ab.
readonly id: string;Eigenschaftswert
string
Hinweise
index
Gibt den nullbasierten Index der Folie zurück, die ihre Position in der Präsentation darstellt.
readonly index: number;Eigenschaftswert
number
Hinweise
layout
Ruft das Layout der Folie ab.
readonly layout: PowerPoint.SlideLayout;Eigenschaftswert
Hinweise
shapes
Gibt eine Auflistung von Formen auf der Folie zurück.
readonly shapes: PowerPoint.ShapeCollection;Eigenschaftswert
Hinweise
slideMaster
Ruft das SlideMaster -Objekt ab, das den Standardinhalt der Folie darstellt.
readonly slideMaster: PowerPoint.SlideMaster;Eigenschaftswert
Hinweise
tags
Gibt eine Auflistung von Tags auf der Folie zurück.
readonly tags: PowerPoint.TagCollection;Eigenschaftswert
Hinweise
Details zur Methode
applyLayout(slideLayout)
Wendet das angegebene Layout auf die Folie an und ändert deren Design und Struktur entsprechend dem ausgewählten Layout.
applyLayout(slideLayout: PowerPoint.SlideLayout): void;Parameter
- slideLayout
- PowerPoint.SlideLayout
Das Layout, das auf die Folie angewendet werden soll. Dies ist in der Regel eine instance eines vordefinierten Layouts aus dem master der Folie.
Gibt zurück
void
Hinweise
delete()
Löscht die Folie aus der Präsentation. Tut nichts, wenn die Folie nicht vorhanden ist.
delete(): void;Gibt zurück
void
Hinweise
[ API-Satz: PowerPointApi 1.2 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml
// Deletes the selected slides.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
const slideCount = slides.getCount();
slides.load("items");
await context.sync();
slides.items.map((slide) => {
slide.delete();
});
});
exportAsBase64()
Exportiert die Folie in eine eigene Präsentationsdatei, die als Base64-codierte Daten zurückgegeben wird.
Hinweis: Diese Methode ist für den Export einer einzelnen Folie optimiert. Das Exportieren mehrerer Folien kann sich auf die Leistung auswirken.
exportAsBase64(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
[ API-Satz: PowerPointApi 1.8 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml
// Exports current slide.
await PowerPoint.run(async (context) => {
const slide = context.presentation.getSelectedSlides().getItemAt(0);
const slideBase64DataResult = slide.exportAsBase64();
const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
await context.sync();
localStorage.setItem("exportedSlide", slideBase64DataResult.value);
localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);
updateSlideImage(imageBase64DataResult.value);
console.log("Slide was exported.");
});
getImageAsBase64(options)
Rendert ein Bild der Folie. Das Bild wird so skaliert, dass es in die gewünschten Dimensionen passt. Wenn Breite und Höhe nicht angegeben sind, wird die tatsächliche Größe der Folie verwendet. Wenn nur eine breite oder höhe angegeben ist, wird die andere berechnet, um das Seitenverhältnis beizubehalten.
getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;Parameter
- options
- PowerPoint.SlideGetImageOptions
Optional. Optionen zum Angeben der gewünschten Größe des Folienbilds.
Gibt zurück
OfficeExtension.ClientResult<string>
Eine Base64-codierte Zeichenfolge des Folienbilds im PNG-Format.
Hinweise
[ API-Satz: PowerPointApi 1.8 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml
// Exports current slide.
await PowerPoint.run(async (context) => {
const slide = context.presentation.getSelectedSlides().getItemAt(0);
const slideBase64DataResult = slide.exportAsBase64();
const imageBase64DataResult = slide.getImageAsBase64({ height: 300 });
await context.sync();
localStorage.setItem("exportedSlide", slideBase64DataResult.value);
localStorage.setItem("exportedSlideImage", imageBase64DataResult.value);
updateSlideImage(imageBase64DataResult.value);
console.log("Slide was exported.");
});
load(options)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames?: string | string[]): PowerPoint.Slide;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
load(propertyNamesAndPaths)
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.Slide;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
moveTo(slideIndex)
Verschiebt die Folie an eine neue Position innerhalb der Präsentation.
moveTo(slideIndex: number): void;Parameter
- slideIndex
-
number
Der nullbasierte Index, an den die Folie verschoben werden soll.
Gibt zurück
void
Hinweise
setSelectedShapes(shapeIds)
Wählt die angegebenen Formen aus. Vorhandene Shape-Auswahl wird durch die neue Auswahl ersetzt.
setSelectedShapes(shapeIds: string[]): void;Parameter
- shapeIds
-
string[]
Liste der Shape-IDs, die auf der Folie ausgewählt werden sollen. Wenn die Liste leer ist, wird die Auswahl gelöscht.
Gibt zurück
void
Hinweise
[ API-Satz: PowerPointApi 1.5 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Reselects shapes that were saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedSlideSelection[0]);
await context.sync();
slide1.setSelectedShapes(savedShapeSelection);
await context.sync();
});
...
// Selects the first two shapes on slide 1.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slide1 = context.presentation.slides.getItemAt(0);
slide1.load("shapes/items/type");
await context.sync();
const shapes = slide1.shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
const shape1: PowerPoint.Shape = shapes[0];
const shape2: PowerPoint.Shape = shapes[1];
shape1.load("id");
shape2.load("id");
await context.sync();
console.log(`IDs: ${shape1.id}, ${shape2.id}`);
slide1.setSelectedShapes([shape1.id, shape2.id]);
await context.sync();
});
toJSON()
Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.Slide Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.SlideData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): PowerPoint.Interfaces.SlideData;