PowerPoint.SlideMaster class

Stellt den Folienmaster einer Folie dar.

Extends

Hinweise

API-Satz: PowerPointApi 1.3

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 Folienmasters 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 Folienmaster zurück.

id

Ruft die eindeutige ID des Folienmasters ab.

layouts

Ruft die Sammlung von Layouts ab, die vom Folienmaster für Folien bereitgestellt werden.

name

Ruft den eindeutigen Namen des Folienmasters ab.

shapes

Gibt eine Sammlung von Formen im Folienmaster zurück.

themeColorScheme

Gibt den des ThemeColorScheme Folienmasters zurück.

Methoden

delete()

Löscht den Folien-master und alle untergeordneten Layouts aus der Präsentation. Tut nichts, wenn die Folie master nicht vorhanden ist. Löst den GeneralException Fehler aus, wenn die Folie master 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.stringifyruft wiederum die toJSON Methode des Objekts auf, das an sie übergeben wird.) Während das ursprüngliche PowerPoint.SlideMaster Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.SlideMasterData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

background

Ruft den Hintergrund des Folienmasters ab.

readonly background: PowerPoint.SlideMasterBackground;

Eigenschaftswert

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

customXmlParts

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

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.7

id

Ruft die eindeutige ID des Folienmasters 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);
    }
  }
});

layouts

Ruft die Sammlung von Layouts ab, die vom Folienmaster für Folien bereitgestellt werden.

readonly layouts: PowerPoint.SlideLayoutCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.3

name

Ruft den eindeutigen Namen des Folienmasters ab.

readonly name: string;

Eigenschaftswert

string

Hinweise

API-Satz: PowerPointApi 1.3

shapes

Gibt eine Sammlung von Formen im Folienmaster zurück.

readonly shapes: PowerPoint.ShapeCollection;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.3

themeColorScheme

Gibt den des ThemeColorScheme Folienmasters zurück.

readonly themeColorScheme: PowerPoint.ThemeColorScheme;

Eigenschaftswert

Hinweise

API-Satz: PowerPointApi 1.10

Details zur Methode

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 den Folien-master und alle untergeordneten Layouts aus der Präsentation. Tut nichts, wenn die Folie master nicht vorhanden ist. Löst den GeneralException Fehler aus, wenn die Folie master 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.SlideMasterLoadOptions): PowerPoint.SlideMaster;

Parameter

options
PowerPoint.Interfaces.SlideMasterLoadOptions

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

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

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

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

toJSON(): PowerPoint.Interfaces.SlideMasterData;

Gibt zurück