PowerPoint.ShapeGroup 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’ID de création du groupe de formes. Retourne null si le groupe de formes n’a pas d’ID de création.

readonly creationId: string | null;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

Obtient l’ID unique du groupe de formes.

readonly id: string;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.8 ]

Retourne l’objet Shape associé au groupe.

readonly shape: PowerPoint.Shape;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.8 ]

Retourne la collection d’objets Shape dans le groupe.

readonly shapes: PowerPoint.ShapeScopedCollection;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.8 ]

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.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;

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

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?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeGroup;

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.ShapeGroup est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.ShapeGroupDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.ShapeGroupData;

Retourne

Dissocie toutes les formes groupées dans la forme spécifiée.

ungroup(): void;

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.8 ]

Exemples

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

await PowerPoint.run(async (context) => {
  // Ungroups the first shape group on the current slide.

  // Get the shapes on the current slide.
  context.presentation.load("slides");
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  slide.load("shapes/items/type,shapes/items/id");
  await context.sync();

  const shapes: PowerPoint.ShapeCollection = slide.shapes;
  const shapeGroups = shapes.items.filter((item) => item.type === PowerPoint.ShapeType.group);
  if (shapeGroups.length === 0) {
    console.warn("No shape groups on the current slide, so nothing to ungroup.");
    return;
  }

  // Ungroup the first grouped shapes.
  const firstGroupId = shapeGroups[0].id;
  const shapeGroupToUngroup = shapes.getItem(firstGroupId);
  shapeGroupToUngroup.group.ungroup();
  await context.sync();

  console.log(`Ungrouped shapes with group ID: ${firstGroupId}`);
});