PowerPoint.SlideLayout class

Stellt das Layout einer Folie dar.

Hinweise

Verwendet von

Beispiele

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

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

Eigenschaften

background	Ruft den Hintergrund des Folienlayouts ab.
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 im Folienlayout zurück.
id	Ruft die eindeutige ID des Folienlayouts ab.
name	Ruft den Namen des Folienlayouts ab.
shapes	Gibt eine Sammlung von Formen im Folienlayout zurück.
themeColorScheme	Gibt den `ThemeColorScheme` des Folienlayouts zurück.
type	Gibt den Typ des Folienlayouts zurück.

Methoden

delete()	Löscht das Folienlayout aus der Präsentation. Tut nichts, wenn das Folienlayout nicht vorhanden ist. Gibt den `GeneralException` Fehler aus, wenn das Folienlayout verwendet wird.
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.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche `PowerPoint.SlideLayout` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `PowerPoint.Interfaces.SlideLayoutData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

background

Ruft den Hintergrund des Folienlayouts ab.

readonly background: PowerPoint.SlideLayoutBackground;

Eigenschaftswert

PowerPoint.SlideLayoutBackground

Hinweise

API-Satz: PowerPointApi 1.10

context

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

context: RequestContext;

Eigenschaftswert

PowerPoint.RequestContext

customXmlParts

Gibt eine Auflistung benutzerdefinierter XML-Komponenten im Folienlayout zurück.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Eigenschaftswert

PowerPoint.CustomXmlPartCollection

Hinweise

API-Satz: PowerPointApi 1.7

id

Ruft die eindeutige ID des Folienlayouts ab.

readonly id: string;

Eigenschaftswert

string

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

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

name

Ruft den Namen des Folienlayouts ab.

readonly name: string;

Eigenschaftswert

string

Hinweise

API-Satz: PowerPointApi 1.3

shapes

Gibt eine Sammlung von Formen im Folienlayout zurück.

readonly shapes: PowerPoint.ShapeCollection;

Eigenschaftswert

PowerPoint.ShapeCollection

Hinweise

API-Satz: PowerPointApi 1.3

themeColorScheme

Gibt den ThemeColorScheme des Folienlayouts zurück.

readonly themeColorScheme: PowerPoint.ThemeColorScheme;

Eigenschaftswert

PowerPoint.ThemeColorScheme

Hinweise

API-Satz: PowerPointApi 1.10

type

Gibt den Typ des Folienlayouts zurück.

readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.8

delete()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Löscht das Folienlayout aus der Präsentation. Tut nichts, wenn das Folienlayout nicht vorhanden ist. Gibt den GeneralException Fehler aus, wenn das Folienlayout verwendet wird.

delete(): void;

Gibt zurück

void

Hinweise

API-Satz: PowerPointApi BETA (NUR VORSCHAU)

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.SlideLayoutLoadOptions): PowerPoint.SlideLayout;

Parameter

options: PowerPoint.Interfaces.SlideLayoutLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

PowerPoint.SlideLayout

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

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

PowerPoint.SlideLayout

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

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

PowerPoint.SlideLayout

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

toJSON(): PowerPoint.Interfaces.SlideLayoutData;

Gibt zurück

PowerPoint.Interfaces.SlideLayoutData

Hinweise

Verwendet von

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

background

Eigenschaftswert

Hinweise

context

Eigenschaftswert

customXmlParts

Eigenschaftswert

Hinweise

id

Eigenschaftswert

Hinweise

Beispiele

name

Eigenschaftswert

Hinweise

shapes

Eigenschaftswert

Hinweise

themeColorScheme

Eigenschaftswert

Hinweise

type

Eigenschaftswert

Hinweise

Details zur Methode

delete()

Gibt zurück

Hinweise

load(options)

Parameter

Gibt zurück

load(propertyNames)

Parameter

Gibt zurück

load(propertyNamesAndPaths)

Parameter

Gibt zurück

toJSON()

Gibt zurück

Feedback