Freigeben über

PowerPoint.Shape class

  • Referenz
Paket:
powerpoint

Stellt eine einzelne Form auf der Folie dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

Beispiele

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

Eigenschaften

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
customXmlParts

Gibt eine Auflistung von benutzerdefinierten XML-Teilen in der Form zurück.
fill

Gibt die Füllungsformatierung dieser Form zurück.
height

Gibt die Höhe der Form in Punkt an. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert festgelegt wird.
id

Ruft die eindeutige ID des Shapes ab.
left

Der Abstand in Punkt von der linken Seite der Form zur linken Seite der Folie.
lineFormat

Gibt die Linienformatierung dieser Form zurück.
name

Gibt den Namen dieser Form an.
tags

Gibt eine Auflistung von Tags in der Form zurück.
textFrame

Gibt das textFrame-Objekt dieser Form zurück.
top

Der Abstand in Punkt vom oberen Rand der Form bis zum oberen Rand der Folie.
type

Gibt den Typ dieser Form zurück. Weitere Informationen finden Sie unter PowerPoint.ShapeType .
width

Gibt die Breite der Form in Punkt an. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert festgelegt wird.

Methoden

delete()

Löscht das Shape aus der Shape-Auflistung. Führt nichts aus, wenn die Form nicht vorhanden ist.
getParentSlide()

Gibt das übergeordnete PowerPoint.Slide-Objekt zurück, das dieses Shapeenthält. Löst eine Ausnahme aus, wenn diese Form nicht zu einem Slidegehört.
getParentSlideLayout()

Gibt das übergeordnete PowerPoint.SlideLayout-Objekt zurück, das dieses Shapeenthält. Löst eine Ausnahme aus, wenn diese Form nicht zu einem SlideLayoutgehört.
getParentSlideLayoutOrNullObject()

Gibt das übergeordnete PowerPoint.SlideLayout-Objekt zurück, das dieses Shapeenthält. Wenn diese Form nicht zu gehört SlideLayout, wird ein Objekt zurückgegeben, auf das eine isNullObject Eigenschaft festgelegt true ist.
getParentSlideMaster()

Gibt das übergeordnete PowerPoint.SlideMaster-Objekt zurück, das dieses Shapeenthält. Löst eine Ausnahme aus, wenn diese Form nicht zu einem SlideMastergehört.
getParentSlideMasterOrNullObject()

Gibt das übergeordnete PowerPoint.SlideMaster-Objekt zurück, das dieses Shapeenthält. Wenn diese Form nicht zu gehört SlideMaster, wird ein Objekt zurückgegeben, auf das eine isNullObject Eigenschaft festgelegt true ist.
getParentSlideOrNullObject()

Gibt das übergeordnete PowerPoint.Slide-Objekt zurück, das dieses Shapeenthält. Wenn diese Form nicht zu gehört Slide, wird ein Objekt zurückgegeben, auf das eine isNullObject Eigenschaft festgelegt true ist.
load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.
toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.Shape Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.ShapeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

PowerPoint.RequestContext

customXmlParts

Gibt eine Auflistung von benutzerdefinierten XML-Teilen in der Form zurück.

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Eigenschaftswert

PowerPoint.CustomXmlPartCollection

Hinweise

[ API-Satz: PowerPointApi 1.7 ]

fill

Gibt die Füllungsformatierung dieser Form zurück.

readonly fill: PowerPoint.ShapeFill;

Eigenschaftswert

PowerPoint.ShapeFill

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

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

Gibt die Höhe der Form in Punkt an. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert festgelegt wird.

height: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

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

Ruft die eindeutige ID des Shapes ab.

readonly id: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

left

Der Abstand in Punkt von der linken Seite der Form zur linken Seite der Folie.

left: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

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

Gibt die Linienformatierung dieser Form zurück.

readonly lineFormat: PowerPoint.ShapeLineFormat;

Eigenschaftswert

PowerPoint.ShapeLineFormat

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

name

Gibt den Namen dieser Form an.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

tags

Gibt eine Auflistung von Tags in der Form zurück.

readonly tags: PowerPoint.TagCollection;

Eigenschaftswert

PowerPoint.TagCollection

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

textFrame

Gibt das textFrame-Objekt dieser Form zurück.

readonly textFrame: PowerPoint.TextFrame;

Eigenschaftswert

PowerPoint.TextFrame

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

top

Der Abstand in Punkt vom oberen Rand der Form bis zum oberen Rand der Folie.

top: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

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

Gibt den Typ dieser Form zurück. Weitere Informationen finden Sie unter 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";

Eigenschaftswert

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

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

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

Gibt die Breite der Form in Punkt an. Löst eine InvalidArgument Ausnahme aus, wenn mit einem negativen Wert festgelegt wird.

width: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Beispiele

// 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;
});

Details zur Methode

delete()

Löscht das Shape aus der Shape-Auflistung. Führt nichts aus, wenn die Form nicht vorhanden ist.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

Beispiele

// 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()

Gibt das übergeordnete PowerPoint.Slide-Objekt zurück, das dieses Shapeenthält. Löst eine Ausnahme aus, wenn diese Form nicht zu einem Slidegehört.

getParentSlide(): PowerPoint.Slide;

Gibt zurück

PowerPoint.Slide

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

getParentSlideLayout()

Gibt das übergeordnete PowerPoint.SlideLayout-Objekt zurück, das dieses Shapeenthält. Löst eine Ausnahme aus, wenn diese Form nicht zu einem SlideLayoutgehört.

getParentSlideLayout(): PowerPoint.SlideLayout;

Gibt zurück

PowerPoint.SlideLayout

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

getParentSlideLayoutOrNullObject()

Gibt das übergeordnete PowerPoint.SlideLayout-Objekt zurück, das dieses Shapeenthält. Wenn diese Form nicht zu gehört SlideLayout, wird ein Objekt zurückgegeben, auf das eine isNullObject Eigenschaft festgelegt true ist.

getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;

Gibt zurück

PowerPoint.SlideLayout

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

getParentSlideMaster()

Gibt das übergeordnete PowerPoint.SlideMaster-Objekt zurück, das dieses Shapeenthält. Löst eine Ausnahme aus, wenn diese Form nicht zu einem SlideMastergehört.

getParentSlideMaster(): PowerPoint.SlideMaster;

Gibt zurück

PowerPoint.SlideMaster

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

getParentSlideMasterOrNullObject()

Gibt das übergeordnete PowerPoint.SlideMaster-Objekt zurück, das dieses Shapeenthält. Wenn diese Form nicht zu gehört SlideMaster, wird ein Objekt zurückgegeben, auf das eine isNullObject Eigenschaft festgelegt true ist.

getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;

Gibt zurück

PowerPoint.SlideMaster

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

getParentSlideOrNullObject()

Gibt das übergeordnete PowerPoint.Slide-Objekt zurück, das dieses Shapeenthält. Wenn diese Form nicht zu gehört Slide, wird ein Objekt zurückgegeben, auf das eine isNullObject Eigenschaft festgelegt true ist.

getParentSlideOrNullObject(): PowerPoint.Slide;

Gibt zurück

PowerPoint.Slide

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;

Parameter

options
PowerPoint.Interfaces.ShapeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

PowerPoint.Shape

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): PowerPoint.Shape;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

PowerPoint.Shape

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.Shape;

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

PowerPoint.Shape

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.Shape Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.ShapeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): PowerPoint.Interfaces.ShapeData;

Gibt zurück

PowerPoint.Interfaces.ShapeData