PowerPoint.Shape 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 propriété

Retourne une collection de parties XML personnalisées dans la forme.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi BETA (PRÉVERSION UNIQUEMENT) ]

Renvoie la mise en forme de remplissage de cette forme.

readonly fill: PowerPoint.ShapeFill;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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 = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape) => {
    shape.fill.setSolidColor("red");
  });
  await context.sync();
});

Spécifie la hauteur, en points, de la forme. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative.

height: number;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

Obtient l’ID unique de la forme.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

Distance, en points, entre le côté gauche de la forme et le côté gauche de la diapositive.

left: number;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

Renvoie la mise en forme de ligne de cette forme.

readonly lineFormat: PowerPoint.ShapeLineFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Spécifie le nom de cette forme.

name: string;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Retourne une collection de balises dans la forme.

readonly tags: PowerPoint.TagCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

Renvoie l’objet textFrame d’une forme.

readonly textFrame: PowerPoint.TextFrame;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Distance, en points, entre le bord supérieur de la forme et le bord supérieur de la diapositive.

top: number;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

Renvoie le type de cette forme. Pour plus d’informations , voir PowerPoint.ShapeType .

readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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

Spécifie la largeur, en points, de la forme. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative.

width: number;

Valeur de propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

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

// Arranges the selected shapes in a line from left to right.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();
  let maxHeight = 0;
  shapes.items.map((shape) => {
    shape.load("width,height");
  });
  await context.sync();
  shapes.items.map((shape) => {
    shape.left = currentLeft;
    shape.top = currentTop;
    currentLeft += shape.width;
    if (shape.height > maxHeight) maxHeight = shape.height;
  });
  await context.sync();
  currentLeft = 0;
  if (currentTop > slideHeight - 200) currentTop = 0;
});

Supprime la forme de la collection de formes. Ne fait rien si la forme n’existe pas.

delete(): void;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

Retourne l’objet PowerPoint.Slide parent qui contient ce Shape. Lève une exception si cette forme n’appartient pas à un Slide.

getParentSlide(): PowerPoint.Slide;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Renvoie l’objet Parent PowerPoint.SlideLayout qui contient ce Shape. Lève une exception si cette forme n’appartient pas à un SlideLayout.

getParentSlideLayout(): PowerPoint.SlideLayout;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Renvoie l’objet Parent PowerPoint.SlideLayout qui contient ce Shape. Si cette forme n’appartient pas à , SlideLayoutun objet avec une isNullObject propriété définie sur true est retourné.

getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Renvoie l’objet PowerPoint.SlideMaster parent qui contient ce Shape. Lève une exception si cette forme n’appartient pas à un SlideMaster.

getParentSlideMaster(): PowerPoint.SlideMaster;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Renvoie l’objet PowerPoint.SlideMaster parent qui contient ce Shape. Si cette forme n’appartient pas à , SlideMasterun objet avec une isNullObject propriété définie sur true est retourné.

getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Retourne l’objet PowerPoint.Slide parent qui contient ce Shape. Si cette forme n’appartient pas à , Slideun objet avec une isNullObject propriété définie sur true est retourné.

getParentSlideOrNullObject(): PowerPoint.Slide;

Retours

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

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.ShapeLoadOptions): PowerPoint.Shape;

Paramètres

Retours

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

Paramètres

Retours

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

Paramètres

Retours

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

toJSON(): PowerPoint.Interfaces.ShapeData;

Retours