PowerPoint.SlideCollection class

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: PowerPoint.Slide[];

Eigenschaftswert

Fügt der Sammlung eine neue Folie hinzu.

add(options?: PowerPoint.AddSlideOptions): void;

Parameter

Gibt zurück

Hinweise

API-Satz: PowerPointApi 1.3

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

const chosenMaster = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;

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();
});

Exportiert eine oder mehrere Folien aus dieser Sammlung in eine eigene Präsentationsdatei, die als Base64-codierte Daten zurückgegeben wird. Löst eine InvalidArgument Ausnahme aus, wenn angegebene Folien-IDs oder Slide Objekte in dieser Auflistung nicht gefunden werden.

exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;

Parameter

Gibt zurück

Eine Base64-codierte Zeichenfolge.

Hinweise

API-Satz: PowerPointApi 1.10

Ruft die Anzahl der Folien in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Die Anzahl der Folien in der Sammlung.

Hinweise

API-Satz: PowerPointApi 1.2

Ruft eine Folie mithilfe ihrer eindeutigen ID ab.

getItem(key: string): PowerPoint.Slide;

Parameter

Gibt zurück

Die Folie mit der eindeutigen ID. Wenn eine solche Folie nicht vorhanden ist, wird ein Fehler ausgelöst.

Hinweise

API-Satz: PowerPointApi 1.2

Ruft eine Folie mit dem nullbasierten Index in der Auflistung ab. Folien werden in der gleichen Reihenfolge gespeichert, in der sie in der Präsentation angezeigt werden.

getItemAt(index: number): PowerPoint.Slide;

Parameter

Gibt zurück

Die Folie am angegebenen Index. Ein Fehler wird ausgelöst, wenn der Index außerhalb des zulässigen Bereichs liegt.

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

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
  const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
  const slide5: PowerPoint.Slide = context.presentation.slides.getItemAt(4);
  slide2.load("id");
  slide4.load("id");
  slide5.load("id");
  try {
    await context.sync();
  } catch (error) {
    console.warn("This action requires at least 5 slides in the presentation.");
    return;
  }
  await context.sync();
  context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
  await context.sync();
});

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

Gibt zurück

Die Folie mit der eindeutigen ID.

Hinweise

API-Satz: PowerPointApi 1.2

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.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;

Parameter

Gibt zurück

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.SlideCollection;

Parameter

Gibt zurück

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.SlideCollection;

Parameter

Gibt zurück

Ü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.SlideCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.SlideCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): PowerPoint.Interfaces.SlideCollectionData;

Gibt zurück