Partager via

PowerPoint.ShapeCollection class

  • Référence
Paquet:
powerpoint

Représente la collection de formes.

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/shapes/get-shapes-by-type.yaml

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  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é.
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.ShapeCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.ShapeCollectionDataque ) 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.3 ]

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

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

Exemples

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

await PowerPoint.run(async function(context) {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  const shape: PowerPoint.Shape = slide.shapes.getItemAt(0);
  shape.tags.add("MOUNTAIN", "Denali");

  await context.sync();

  const myShapeTag: PowerPoint.Tag = shape.tags.getItem("MOUNTAIN");
  myShapeTag.load("key, value");

  await context.sync();

  console.log("Added key " + JSON.stringify(myShapeTag.key) + " with value " + JSON.stringify(myShapeTag.value));
});

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

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

Paramètres

options

PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Retours

PowerPoint.ShapeCollection

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

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

Exemples

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

// Changes the transparency of every geometric shape in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the shape transparency to be halfway transparent.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.geometricShape) {
      shape.fill.transparency = 0.5;
    }
  });
  await context.sync();
});

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

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

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

Retours

PowerPoint.Interfaces.ShapeCollectionData