PowerPoint.SlideScopedCollection class

Paquet:: powerpoint

Représente une 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/shapes/get-set-shapes.yaml

// Saves which shapes are selected so that they can be reselected later.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
  const slideCount = slides.getCount();
  slides.load("items");
  await context.sync();
  savedSlideSelection = [];
  slides.items.map((slide) => {
    savedSlideSelection.push(slide.id);
  });
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    savedShapeSelection.push(shape.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

exportAsBase64Presentation()	Exporte toutes les diapositives de cette collection vers leur propre fichier de présentation, retourné sous forme de données codées en Base64.
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.
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`, à son tour, appelle la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet d’origine `PowerPoint.SlideScopedCollection` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `PowerPoint.Interfaces.SlideScopedCollectionData`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

exportAsBase64Presentation()

Exporte toutes les diapositives de cette collection vers leur propre fichier de présentation, retourné sous forme de données codées en Base64.

exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Chaîne encodée en Base64.

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

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.5 ]

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.5 ]

getItemAt(index)

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

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.5 ]

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.5 ]

Exemples

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

// Uses getItemOrNullObject to find a slide by ID within the selected slides.
// If the ID isn't found in the selected slides, the returned object's isNullObject property is true.
// If the ID is found in the selected slides, presentation displays that slide.
await PowerPoint.run(async (context) => {
  const slideId = (document.getElementById("slide-id-input") as HTMLInputElement).value.trim();
  if (!slideId) {
    console.log("Enter a slide ID in the text box first.");
    return;
  }

  const selectedSlides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();

  // getItemOrNullObject returns a Slide object without throwing if the ID isn't found.
  const slide: PowerPoint.Slide = selectedSlides.getItemOrNullObject(slideId);
  slide.load("id");
  await context.sync();

  if (slide.isNullObject) {
    console.log(`Slide ID "${slideId}" was not found in the selected slides.`);
  } else {
    console.log(`Slide found in the selected slides.`);
    console.log(`  ID: ${slide.id}`);

    // Switch to the slide.
    context.presentation.setSelectedSlides([slide.id]);
    await context.sync();

    console.log(`Switched to the slide - ID: ${slide.id}`);
  }
});

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

Paramètres

options: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Retours

PowerPoint.SlideScopedCollection

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

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

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

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

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.SlideScopedCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.SlideScopedCollectionDataque ) 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.SlideScopedCollectionData;

Retours

PowerPoint.Interfaces.SlideScopedCollectionData

Commentaires

Cette page a-t-elle été utile ?

Partager via

PowerPoint.SlideScopedCollection 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

exportAsBase64Presentation()

Retours

Remarques

getCount()

Retours

Remarques

getItem(key)

Paramètres

Retours

Remarques

getItemAt(index)

Paramètres

Retours

Remarques

getItemOrNullObject(id)

Paramètres

Retours

Remarques

Exemples

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Commentaires