Partager via

PowerPoint.Shape class

  • Référence
Paquet:
powerpoint

Représente une forme unique dans la diapositive.

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

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

Renvoie la mise en forme de remplissage de cette forme.
height

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

Obtient l’ID unique de la forme.
left

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

Renvoie la mise en forme de ligne de cette forme.
name

Spécifie le nom de cette forme.
tags

Retourne une collection de balises dans la forme.
textFrame

Renvoie l’objet textFrame d’une forme.
top

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

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

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

Méthodes

delete()

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

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

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

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é.
getParentSlideMaster()

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

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é.
getParentSlideOrNullObject()

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

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

customXmlParts

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

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Valeur de propriété

PowerPoint.CustomXmlPartCollection

Remarques

[ Ensemble d’API : PowerPointApi 1.7 ]

fill

Renvoie la mise en forme de remplissage de cette forme.

readonly fill: PowerPoint.ShapeFill;

Valeur de propriété

PowerPoint.ShapeFill

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

height

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é

number

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: PowerPoint.ShapeScopedCollection = 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;
});

id

Obtient l’ID unique de la forme.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

left

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é

number

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: PowerPoint.ShapeScopedCollection = 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;
});

lineFormat

Renvoie la mise en forme de ligne de cette forme.

readonly lineFormat: PowerPoint.ShapeLineFormat;

Valeur de propriété

PowerPoint.ShapeLineFormat

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

name

Spécifie le nom de cette forme.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

tags

Retourne une collection de balises dans la forme.

readonly tags: PowerPoint.TagCollection;

Valeur de propriété

PowerPoint.TagCollection

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

textFrame

Renvoie l’objet textFrame d’une forme.

readonly textFrame: PowerPoint.TextFrame;

Valeur de propriété

PowerPoint.TextFrame

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

top

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é

number

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: PowerPoint.ShapeScopedCollection = 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;
});

type

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

readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";

Valeur de propriété

PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox"

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

width

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é

number

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: PowerPoint.ShapeScopedCollection = 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;
});

Détails de la méthode

delete()

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

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : PowerPointApi 1.3 ]

Exemples

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

// This function gets the collection of shapes on the first slide,
// and then iterates through them, deleting each one.
await PowerPoint.run(async (context) => {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  const shapes: PowerPoint.ShapeCollection = slide.shapes;

  // Load all the shapes in the collection without loading their properties.
  shapes.load("items/$none");

  await context.sync();

  shapes.items.forEach((shape) => shape.delete());

  await context.sync();
});

getParentSlide()

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

PowerPoint.Slide

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

getParentSlideLayout()

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

PowerPoint.SlideLayout

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

getParentSlideLayoutOrNullObject()

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

PowerPoint.SlideLayout

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

getParentSlideMaster()

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

PowerPoint.SlideMaster

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

getParentSlideMasterOrNullObject()

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

PowerPoint.SlideMaster

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

getParentSlideOrNullObject()

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

PowerPoint.Slide

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

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

Paramètres

options
PowerPoint.Interfaces.ShapeLoadOptions

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

Retours

PowerPoint.Shape

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

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

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

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

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

PowerPoint.Interfaces.ShapeData