PowerPoint.SlideCollection class

Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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 am Ende der Auflistung 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 = $("#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();
});

Ruft die Anzahl der Folien in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Die Anzahl der Folien in der Auflistung.

Hinweise

[ API-Satz: PowerPointApi 1.2 ]

Ruft eine Folie mit 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 mithilfe des nullbasierten Indexes in der Auflistung ab. Folien werden in der gleichen Reihenfolge wie in der Präsentation gespeichert.

getItemAt(index: number): PowerPoint.Slide;

Parameter

Gibt zurück

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

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 = context.presentation.slides.getItemAt(1);
  const slide4 = context.presentation.slides.getItemAt(3);
  const slide5 = 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 mit ihrer eindeutigen ID ab. Wenn eine solche Folie nicht vorhanden ist, wird ein Objekt zurückgegeben, bei dem eine isNullObject Eigenschaft 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 das Objekt ü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 Auflistung enthält.

toJSON(): PowerPoint.Interfaces.SlideCollectionData;

Gibt zurück