PowerPoint.Slide class

Stellt eine einzelne Folie einer Präsentation dar.

Extends

Hinweise

API-Satz: PowerPointApi 1.2

Verwendet von

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 dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

customXmlParts

Gibt eine Auflistung benutzerdefinierter XML-Komponenten in der Folie zurück.

hyperlinks

Gibt eine Sammlung von Links auf der Folie zurück.

id

Ruft die eindeutige ID der Folie ab.

layout

Ruft das Layout der Folie ab.

shapes

Gibt eine Sammlung von Formen auf der Folie zurück.

slideMaster

Ruft das SlideMaster Objekt ab, das den Standardinhalt der Folie darstellt.

tags

Gibt eine Sammlung von Tags auf der Folie zurück.

Methoden

delete()

Löscht die Folie aus der Präsentation. Tut nichts, wenn die Folie nicht vorhanden ist.

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(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(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.

setSelectedShapes(shapeIds)

Wählt die angegebenen Formen aus. Die vorhandene Formenauswahl wird durch die neue Auswahl ersetzt.

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.Slide Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.SlideData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

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

customXmlParts

Gibt eine Auflistung benutzerdefinierter XML-Komponenten in der Folie zurück.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.7

Gibt eine Sammlung von Links auf der Folie zurück.

readonly hyperlinks: PowerPoint.HyperlinkCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.6

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/hyperlinks/manage-hyperlinks.yaml

// Sets a hyperlink on the first selected shape.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  const shape: PowerPoint.Shape = context.presentation.getSelectedShapes().getItemAt(0).load("id,type");
  const hyperlinks: PowerPoint.HyperlinkCollection = slide.hyperlinks;
  const hyperlinkAddOptions: PowerPoint.HyperlinkAddOptions = {
    address: "https://bing.com",
    screenTip: "Screen tip for shape",
  };
  let hyperlink: PowerPoint.Hyperlink = hyperlinks.add(shape, hyperlinkAddOptions).load("address,screenTip");
  try {
    await context.sync();
  } catch {
    console.warn("Confirm that you have at least one slide and you've selected a shape on the active slide.");
    return;
  }

  console.log(
    `Added link "${hyperlink.address}" (screen tip: "${hyperlink.screenTip}") to the first selected shape (ID: ${shape.id}, type: ${shape.type}).`,
  );
});

id

Ruft die eindeutige ID der Folie ab.

readonly id: string;

Eigenschaftswert

string

Hinweise

API-Satz: PowerPointApi 1.2

layout

Ruft das Layout der Folie ab.

readonly layout: PowerPoint.SlideLayout;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.3

shapes

Gibt eine Sammlung von Formen auf der Folie zurück.

readonly shapes: PowerPoint.ShapeCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.3

slideMaster

Ruft das SlideMaster Objekt ab, das den Standardinhalt der Folie darstellt.

readonly slideMaster: PowerPoint.SlideMaster;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.3

tags

Gibt eine Sammlung von Tags auf der Folie zurück.

readonly tags: PowerPoint.TagCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.3

Details zur Methode

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

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

options
PowerPoint.Interfaces.SlideLoadOptions

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

setSelectedShapes(shapeIds)

Wählt die angegebenen Formen aus. Die vorhandene Formenauswahl wird durch die neue Auswahl ersetzt.

setSelectedShapes(shapeIds: string[]): void;

Parameter

shapeIds

string[]

Liste der Form-IDs, die auf der Folie ausgewählt werden sollen. Wenn die Liste leer ist, wird die Auswahl aufgehoben.

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 sie übergeben wird.) Während das ursprüngliche PowerPoint.Slide Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.SlideData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): PowerPoint.Interfaces.SlideData;

Gibt zurück