PowerPoint.SlideCollection class

Référence

Paquet:: powerpoint

Représente la collection de diapositives dans la présentation.

Extends: OfficeExtension.ClientObject

Remarques

Exemples

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

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

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

add(options)	Ajoute une nouvelle diapositive à la fin de la collection.
getCount()	Obtient le nombre de diapositives dans la collection.
getItem(key)	Obtient une diapositive à l’aide de son ID unique.
getItemAt(index)	Obtient une diapositive à l’aide de son index de base zéro dans la collection. Les diapositives sont stockées dans le même ordre qu’elles sont affichées dans la présentation.
getItemOrNullObject(id)	Obtient une diapositive à l’aide de son ID unique. Si une telle diapositive 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`appelle à son tour la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet d’origine `PowerPoint.SlideCollection` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `PowerPoint.Interfaces.SlideCollectionData`que ) 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.Slide[];

Valeur de propriété

PowerPoint.Slide[]

Détails de la méthode

add(options)

Ajoute une nouvelle diapositive à la fin de la collection.

add(options?: PowerPoint.AddSlideOptions): void;

Paramètres

options: PowerPoint.AddSlideOptions

Options qui définissent le thème de la nouvelle diapositive.

Retours

void

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

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

getCount()

Obtient le nombre de diapositives dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Nombre de diapositives dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi 1.2 ]

getItem(key)

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

getItem(key: string): PowerPoint.Slide;

Paramètres

key: string

ID de la diapositive.

Retours

PowerPoint.Slide

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

Remarques

[ Ensemble d’API : PowerPointApi 1.2 ]

getItemAt(index)

Obtient une diapositive à l’aide de son index de base zéro dans la collection. Les diapositives sont stockées dans le même ordre qu’elles sont affichées dans la présentation.

getItemAt(index: number): PowerPoint.Slide;

Paramètres

index: number

Index de la diapositive de la collection.

Retours

PowerPoint.Slide

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

Remarques

[ Ensemble d’API : PowerPointApi 1.2 ]

Exemples

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

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
  const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
  const slide5: PowerPoint.Slide = context.presentation.slides.getItemAt(4);
  slide2.load("id");
  slide4.load("id");
  slide5.load("id");
  try {
    await context.sync();
  } catch (error) {
    console.warn("This action requires at least 5 slides in the presentation.");
    return;
  }
  await context.sync();
  context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
  await context.sync();
});

getItemOrNullObject(id)

Obtient une diapositive à l’aide de son ID unique. Si une telle diapositive 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.Slide;

Paramètres

id: string

ID de la diapositive.

Retours

PowerPoint.Slide

Diapositive avec l’ID unique.

Remarques

[ Ensemble d’API : PowerPointApi 1.2 ]

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.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;

Paramètres

options: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Retours

PowerPoint.SlideCollection

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

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

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

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

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.SlideCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.SlideCollectionDataque ) 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.SlideCollectionData;

Retours

PowerPoint.Interfaces.SlideCollectionData

Partager via

PowerPoint.SlideCollection class

Remarques

Exemples

Propriétés

Méthodes

Détails de la propriété

context

Valeur de propriété

items

Valeur de propriété

Détails de la méthode

add(options)

Paramètres

Retours

Remarques

Exemples

getCount()

Retours

Remarques

getItem(key)

Paramètres

Retours

Remarques

getItemAt(index)

Paramètres

Retours

Remarques

Exemples

getItemOrNullObject(id)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Ressources supplémentaires