PowerPoint.Shape class

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

context: RequestContext;

Eigenschaftswert

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

readonly customXmlParts: PowerPoint.CustomXmlPartCollection;

Eigenschaftswert

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

Gibt die Füllungsformatierung dieser Form zurück.

readonly fill: PowerPoint.ShapeFill;

Eigenschaftswert

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

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

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

Ruft die eindeutige ID des Shapes ab.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

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

left: number;

Eigenschaftswert

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

Gibt die Linienformatierung dieser Form zurück.

readonly lineFormat: PowerPoint.ShapeLineFormat;

Eigenschaftswert

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

Gibt den Namen dieser Form an.

name: string;

Eigenschaftswert

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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

readonly tags: PowerPoint.TagCollection;

Eigenschaftswert

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

Gibt das textFrame-Objekt dieser Form zurück.

readonly textFrame: PowerPoint.TextFrame;

Eigenschaftswert

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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

top: number;

Eigenschaftswert

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

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

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

Eigenschaftswert

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

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

width: number;

Eigenschaftswert

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

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

delete(): void;

Gibt zurück

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

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

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

Hinweise

[ API-Satz: PowerPointApi 1.5 ]

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Ü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