PowerPoint.SlideLayoutCollection class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: PowerPoint.SlideLayout[];

Valeur de propriété

Obtient le nombre de mises en page dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Nombre de mises en page dans la collection.

Remarques

Jeu d’API : PowerPointApi 1.3

Obtient une mise en page à l’aide de son ID unique.

getItem(key: string): PowerPoint.SlideLayout;

Paramètres

Retours

Disposition avec l’ID unique. Si une telle disposition n’existe pas, une erreur est générée.

Remarques

Jeu d’API : PowerPointApi 1.3

Obtient une mise en page à l’aide de son index de base zéro dans la collection.

getItemAt(index: number): PowerPoint.SlideLayout;

Paramètres

Retours

Disposition à l’index donné. Une erreur est générée si l’index est hors plage.

Remarques

Jeu d’API : PowerPointApi 1.3

Obtient une mise en page à l’aide de son ID unique. Si une telle disposition n’existe pas, un objet avec une isNullObject propriété définie sur true est renvoyé. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

Paramètres

Retours

Disposition avec l’ID unique.

Remarques

Jeu d’API : PowerPointApi 1.3

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;

Paramètres

Retours

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.SlideLayoutCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.SlideLayoutCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;

Retours