PowerPoint.Shape class
Stellt eine einzelne Form auf der Folie dar.
- Extends
Hinweise
[ API-Satz: PowerPointApi 1.3 ]
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| fill | Gibt die Füllungsformatierung dieser Form zurück. |
| height | Gibt die Höhe der Form in Punkt an. Löst eine |
| id | Ruft die eindeutige ID des Shapes ab. |
| left | Der Abstand in Punkt von der linken Seite der Form zur linken Seite der Folie. |
| line |
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. |
| text |
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 |
Methoden
| delete() | Löscht das Shape aus der Shape-Auflistung. Führt nichts aus, wenn die Form nicht vorhanden ist. |
| get |
Gibt das übergeordnete PowerPoint.Slide-Objekt zurück, das dieses |
| get |
Gibt das übergeordnete PowerPoint.SlideLayout-Objekt zurück, das dieses |
| get |
Gibt das übergeordnete PowerPoint.SlideLayout-Objekt zurück, das dieses |
| get |
Gibt das übergeordnete PowerPoint.SlideMaster-Objekt zurück, das dieses |
| get |
Gibt das übergeordnete PowerPoint.SlideMaster-Objekt zurück, das dieses |
| get |
Gibt das übergeordnete PowerPoint.Slide-Objekt zurück, das dieses |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
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
fill
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();
});
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 = 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
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 = 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
Hinweise
name
Gibt den Namen dieser Form an.
name: string;Eigenschaftswert
string
Hinweise
tags
Gibt eine Auflistung von Tags in der Form zurück.
readonly tags: PowerPoint.TagCollection;Eigenschaftswert
Hinweise
textFrame
Gibt das textFrame-Objekt dieser Form zurück.
readonly textFrame: PowerPoint.TextFrame;Eigenschaftswert
Hinweise
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 = 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";Eigenschaftswert
PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table"
Hinweise
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 = 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
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
Hinweise
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
Hinweise
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
Hinweise
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
Hinweise
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
Hinweise
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
Hinweise
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
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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
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
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
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für