PowerPoint.ShapeScopedCollection class

Paquet:: powerpoint

Représente une collection de formes.

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

// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items/fill/type");
  await context.sync();
  shapes.items.map((shape) => {
    const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
    console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
    shape.fill.setSolidColor("red");
  });
  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

getCount()	Obtient le nombre de formes dans la collection.
getItem(key)	Obtient une forme à l’aide de son ID unique. Une erreur est générée si la forme n’existe pas.
getItemAt(index)	Obtient une forme à l’aide de son index de base zéro dans la collection. Une erreur est générée si l’index est hors limites.
getItemOrNullObject(id)	Obtient une forme à l’aide de son ID unique. Si une telle forme 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.
group()	Regroupe toutes les formes de cette collection en une seule forme. Si la collection contient moins de deux formes, cette méthode retourne l’erreur `GeneralException` .
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.ShapeScopedCollection` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `PowerPoint.Interfaces.ShapeScopedCollectionData`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.Shape[];

Valeur de propriété

PowerPoint.Shape[]

Détails de la méthode

getCount()

Obtient le nombre de formes dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Nombre de formes dans la collection.

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Exemples

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

// Gets the shapes you selected on the slide and displays their IDs on the task pane.
await PowerPoint.run(async (context) => {
  let finalTable = "";
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();
  finalTable += "<br>getSelectedShapes.getCount returned:<b>" + shapeCount.value + "</b><br>";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape, index) => {
    finalTable += "<tr><td>" + index + "</td><td>" + shape.id + "</td></tr>";
  });
  finalTable += "</table>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = "";
  outputSpan.innerHTML += finalTable;
});

getItem(key)

Obtient une forme à l’aide de son ID unique. Une erreur est générée si la forme n’existe pas.

getItem(key: string): PowerPoint.Shape;

Paramètres

key: string

ID de la forme.

Retours

PowerPoint.Shape

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

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

getItemAt(index)

Obtient une forme à l’aide de son index de base zéro dans la collection. Une erreur est générée si l’index est hors limites.

getItemAt(index: number): PowerPoint.Shape;

Paramètres

index: number

Index de la forme dans la collection.

Retours

PowerPoint.Shape

Forme à 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 forme à l’aide de son ID unique. Si une telle forme 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.Shape;

Paramètres

id: string

ID de la forme.

Retours

PowerPoint.Shape

Forme avec l’ID unique. Si une telle forme n’existe pas, un objet avec une isNullObject propriété définie sur true est retourné.

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

group()

Regroupe toutes les formes de cette collection en une seule forme. Si la collection contient moins de deux formes, cette méthode retourne l’erreur GeneralException .

group(): PowerPoint.Shape;

Retours

PowerPoint.Shape

Forme groupée nouvellement créée en tant que PowerPoint.Shape.

Remarques

[ Ensemble d’API : PowerPointApi 1.8 ]

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

Paramètres

options: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Retours

PowerPoint.ShapeScopedCollection

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

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

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

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

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

Retours

PowerPoint.Interfaces.ShapeScopedCollectionData

Commentaires

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

Partager via

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

getCount()

Retours

Remarques

Exemples

getItem(key)

Paramètres

Retours

Remarques

getItemAt(index)

Paramètres

Retours

Remarques

getItemOrNullObject(id)

Paramètres

Retours

Remarques

group()

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Commentaires