PowerPoint.SlideScopedCollection class
Stellt eine Sammlung von Folien in der Präsentation dar.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Saves which shapes are selected so that they can be reselected later.
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();
savedSlideSelection = [];
slides.items.map((slide) => {
savedSlideSelection.push(slide.id);
});
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
shapes.items.map((shape) => {
savedShapeSelection.push(shape.id);
});
});
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| export |
Exportiert alle Folien in dieser Sammlung in eine eigene Präsentationsdatei, die als Base64-codierte Daten zurückgegeben wird. |
| get |
Ruft die Anzahl der Folien in der Sammlung ab. |
| get |
Ruft eine Folie mithilfe ihrer eindeutigen ID ab. |
| get |
Ruft eine Folie mit dem nullbasierten Index in der Auflistung ab. |
| get |
Ruft eine Folie mithilfe ihrer eindeutigen ID ab. Wenn eine solche Folie nicht vorhanden ist, wird ein Objekt mit einer |
| 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 " |
| toJSON() | Überschreibt die JavaScript-Methode |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: PowerPoint.Slide[];Eigenschaftswert
Details zur Methode
exportAsBase64Presentation()
Exportiert alle Folien in dieser Sammlung in eine eigene Präsentationsdatei, die als Base64-codierte Daten zurückgegeben wird.
exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Eine Base64-codierte Zeichenfolge.
Hinweise
getCount()
Ruft die Anzahl der Folien in der Sammlung ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Die Anzahl der Folien in der Sammlung.
Hinweise
getItem(key)
Ruft eine Folie mithilfe ihrer eindeutigen ID ab.
getItem(key: string): PowerPoint.Slide;Parameter
- key
-
string
Die ID der Folie.
Gibt zurück
Die Folie mit der eindeutigen ID. Wenn eine solche Folie nicht vorhanden ist, wird ein Fehler ausgelöst.
Hinweise
getItemAt(index)
Ruft eine Folie mit dem nullbasierten Index in der Auflistung ab.
getItemAt(index: number): PowerPoint.Slide;Parameter
- index
-
number
Der Index der Folie in der Sammlung.
Gibt zurück
Die Folie am angegebenen Index. Ein Fehler wird ausgelöst, wenn der Index außerhalb des zulässigen Bereichs liegt.
Hinweise
getItemOrNullObject(id)
Ruft eine Folie mithilfe ihrer eindeutigen ID ab. Wenn eine solche Folie nicht vorhanden ist, wird ein Objekt mit einer isNullObject Eigenschaft zurückgegeben, die auf true festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(id: string): PowerPoint.Slide;Parameter
- id
-
string
Die ID der Folie.
Gibt zurück
Die Folie mit der eindeutigen ID.
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-slide-by-id.yaml
// Uses getItemOrNullObject to find a slide by ID within the selected slides.
// If the ID isn't found in the selected slides, the returned object's isNullObject property is true.
// If the ID is found in the selected slides, presentation displays that slide.
await PowerPoint.run(async (context) => {
const slideId = (document.getElementById("slide-id-input") as HTMLInputElement).value.trim();
if (!slideId) {
console.log("Enter a slide ID in the text box first.");
return;
}
const selectedSlides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
// getItemOrNullObject returns a Slide object without throwing if the ID isn't found.
const slide: PowerPoint.Slide = selectedSlides.getItemOrNullObject(slideId);
slide.load("id");
await context.sync();
if (slide.isNullObject) {
console.log(`Slide ID "${slideId}" was not found in the selected slides.`);
} else {
console.log(`Slide found in the selected slides.`);
console.log(` ID: ${slide.id}`);
// Switch to the slide.
context.presentation.setSelectedSlides([slide.id]);
await context.sync();
console.log(`Switched to the slide - ID: ${slide.id}`);
}
});
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.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;Parameter
- options
-
PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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.SlideScopedCollection;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?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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 sie übergeben wird.) Während das ursprüngliche PowerPoint.SlideScopedCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.SlideScopedCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;