Partager via

PowerPoint.SlideLayoutCollection class

  • Référence
Paquet:
powerpoint

Représente la collection de dispositions fournies par le masque des diapositives pour les diapositives.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

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

Propriétés

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
items

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

Méthodes

getCount()

Obtient le nombre de dispositions dans la collection.
getItem(key)

Obtient une disposition à l’aide de son ID unique.
getItemAt(index)

Obtient une disposition à l’aide de son index de base zéro dans la collection.
getItemOrNullObject(id)

Obtient une disposition à 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 retourné. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
load(options)

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)

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)

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

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 brut (typé en tant PowerPoint.Interfaces.SlideLayoutCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.SlideLayout[];

Valeur de propriété

PowerPoint.SlideLayout[]

Détails de la méthode

getCount()

Obtient le nombre de dispositions dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Nombre de dispositions dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

getItem(key)

Obtient une disposition à l’aide de son ID unique.

getItem(key: string): PowerPoint.SlideLayout;

Paramètres

key

string

ID de la disposition.

Retours

PowerPoint.SlideLayout

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

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

getItemAt(index)

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

getItemAt(index: number): PowerPoint.SlideLayout;

Paramètres

index

number

Index de la disposition dans la collection.

Retours

PowerPoint.SlideLayout

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

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

getItemOrNullObject(id)

Obtient une disposition à 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 retourné. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

Paramètres

id

string

ID de la disposition.

Retours

PowerPoint.SlideLayout

Disposition avec l’ID unique.

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

load(options)

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

options

PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

PowerPoint.SlideLayoutCollection

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

PowerPoint.SlideLayoutCollection

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

PowerPoint.SlideLayoutCollection

toJSON()

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 brut (typé en tant PowerPoint.Interfaces.SlideLayoutCollectionDataque ) qui 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

PowerPoint.Interfaces.SlideLayoutCollectionData