PowerPoint.SlideCollection class

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 la propriété

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

readonly items: PowerPoint.Slide[];

Valeur de la propriété

Ajoute une nouvelle diapositive à la collection.

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

Paramètres

Retourne

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 = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;

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

Exporte une ou plusieurs diapositives trouvées dans cette collection vers leur propre fichier de présentation, retourné sous forme de données codées en Base64. Lève une InvalidArgument exception si les ID de diapositive ou Slide les objets fournis sont introuvables dans cette collection.

exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;

Paramètres

Retourne

Chaîne encodée en Base64.

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

Obtient le nombre de diapositives dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retourne

Nombre de diapositives dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi 1.2 ]

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

getItem(key: string): PowerPoint.Slide;

Paramètres

Retourne

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 ]

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

Retourne

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

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

Retourne

Diapositive avec l’ID unique.

Remarques

[ Ensemble d’API : PowerPointApi 1.2 ]

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

Retourne

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

Retourne

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

Retourne

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

Retourne