PowerPoint.ShapeCollection class

Paket:: powerpoint

Stellt die Auflistung von Shapes dar.

Extends: OfficeExtension.ClientObject

Hinweise

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.
items	Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

addGeometricShape(geometricShapeType, options)	Fügt der Folie eine geometrische Form hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Form darstellt.
addGeometricShape(geometricShapeType, options)	Fügt der Folie eine geometrische Form hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Form darstellt.
addGroup(values)	Erstellen Sie eine Shape-Gruppe für mehrere Formen.
addLine(connectorType, options)	Fügt der Folie eine Linie hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Zeile darstellt.
addLine(connectorType, options)	Fügt der Folie eine Linie hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Zeile darstellt.
addTable(rowCount, columnCount, options)	Fügt der Folie eine Tabelle hinzu. Gibt ein `Shape` -Objekt zurück, das die neue Tabelle darstellt. Verwenden Sie die `Shape.table` -Eigenschaft, um das `Table` -Objekt für die Form abzurufen.
addTextBox(text, options)	Fügt der Folie ein Textfeld mit dem bereitgestellten Text als Inhalt hinzu. Gibt ein `Shape` -Objekt zurück, das das neue Textfeld darstellt.
getCount()	Ruft die Anzahl der Shapes in der Auflistung ab.
getItem(key)	Ruft ein Shape unter Verwendung seiner eindeutigen ID ab. Wenn die Form nicht vorhanden ist, wird ein Fehler ausgelöst.
getItemAt(index)	Ruft ein Shape mit seinem nullbasierten Index in der Auflistung ab. Wenn sich der Index außerhalb des zulässigen Bereichs befindet, wird ein Fehler ausgelöst.
getItemOrNullObject(id)	Ruft ein Shape unter Verwendung seiner eindeutigen ID ab. Wenn eine solche Form nicht vorhanden ist, wird ein Objekt zurückgegeben, bei dem eine `isNullObject` Eigenschaft auf true festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
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.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche `PowerPoint.ShapeCollection` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `PowerPoint.Interfaces.ShapeCollectionData`) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung 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

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: PowerPoint.Shape[];

Eigenschaftswert

PowerPoint.Shape[]

Details zur Methode

addGeometricShape(geometricShapeType, options)

Fügt der Folie eine geometrische Form hinzu. Gibt ein Shape -Objekt zurück, das die neue Form darstellt.

addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

Parameter

geometricShapeType: PowerPoint.GeometricShapeType

Gibt den Typ der geometrischen Form an. Weitere Informationen finden Sie unter PowerPoint.GeometricShapeType .

options: PowerPoint.ShapeAddOptions

Ein optionaler Parameter, um die zusätzlichen Optionen anzugeben, z. B. die Position der Form.

Gibt zurück

PowerPoint.Shape

Die neu eingefügte Form.

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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 adds a hexagon shape to the collection, while specifying its
// location and size. Then it names the shape.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  const shapeOptions: PowerPoint.ShapeAddOptions = {
    left: 100,
    top: 100,
    height: 150,
    width: 150,
  };
  const hexagon: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.hexagon, shapeOptions);
  hexagon.name = "Hexagon";

  await context.sync();
});

addGeometricShape(geometricShapeType, options)

Fügt der Folie eine geometrische Form hinzu. Gibt ein Shape -Objekt zurück, das die neue Form darstellt.

addGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

Parameter

geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus"

Gibt den Typ der geometrischen Form an. Weitere Informationen finden Sie unter PowerPoint.GeometricShapeType .

options: PowerPoint.ShapeAddOptions

Ein optionaler Parameter, um die zusätzlichen Optionen anzugeben, z. B. die Position der Form.

Gibt zurück

PowerPoint.Shape

Die neu eingefügte Form.

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

addGroup(values)

Erstellen Sie eine Shape-Gruppe für mehrere Formen.

addGroup(values: Array<string | Shape>): PowerPoint.Shape;

Parameter

values: Array<string | PowerPoint.Shape>

Ein Array von Shape-IDs oder Shape -Objekten.

Gibt zurück

PowerPoint.Shape

Ein Shape -Objekt, das die Formgruppe darstellt. Verwenden Sie die Shape.group -Eigenschaft, um auf das ShapeGroup -Objekt für die Gruppe zuzugreifen.

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

Beispiele

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

await PowerPoint.run(async (context) => {
  // Groups the geometric shapes on the current slide.

  // Get the shapes on the current slide.
  context.presentation.load("slides");
  const slide: PowerPoint.Slide = context.presentation.getSelectedSlides().getItemAt(0);
  slide.load("shapes/items/type,shapes/items/id");
  await context.sync();

  const shapes: PowerPoint.ShapeCollection = slide.shapes;
  const shapesToGroup = shapes.items.filter((item) => item.type === PowerPoint.ShapeType.geometricShape);
  if (shapesToGroup.length === 0) {
    console.warn("No shapes on the current slide, so nothing to group.");
    return;
  }

  // Group the geometric shapes.
  console.log(`Number of shapes to group: ${shapesToGroup.length}`);
  const group = shapes.addGroup(shapesToGroup);
  group.load("id");
  await context.sync();

  console.log(`Grouped shapes. Group ID: ${group.id}`);
});

addLine(connectorType, options)

Fügt der Folie eine Linie hinzu. Gibt ein Shape -Objekt zurück, das die neue Zeile darstellt.

addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

Parameter

connectorType: PowerPoint.ConnectorType

Gibt den Verbindungstyp der Linie an. Falls nicht angegeben, straight wird der Connectortyp verwendet. Weitere Informationen finden Sie unter PowerPoint.ConnectorType .

options: PowerPoint.ShapeAddOptions

Ein optionaler Parameter, um die zusätzlichen Optionen anzugeben, z. B. die Position des Shape-Objekts, das die Linie enthält.

Gibt zurück

PowerPoint.Shape

Die neu eingefügte Form.

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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 adds a line to the collection, while specifying its
// start and end points. Then it names the shape.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;

  // For a line, left and top are the coordinates of the start point,
  // while height and width are the coordinates of the end point.
  const line: PowerPoint.Shape = shapes.addLine(PowerPoint.ConnectorType.straight, {
    left: 400,
    top: 200,
    height: 20,
    width: 150,
  });
  line.name = "StraightLine";

  await context.sync();
});

addLine(connectorType, options)

Fügt der Folie eine Linie hinzu. Gibt ein Shape -Objekt zurück, das die neue Zeile darstellt.

addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

Parameter

connectorType: "Straight" | "Elbow" | "Curve"

Gibt den Verbindungstyp der Linie an. Falls nicht angegeben, straight wird der Connectortyp verwendet. Weitere Informationen finden Sie unter PowerPoint.ConnectorType .

options: PowerPoint.ShapeAddOptions

Ein optionaler Parameter, um die zusätzlichen Optionen anzugeben, z. B. die Position des Shape-Objekts, das die Linie enthält.

Gibt zurück

PowerPoint.Shape

Die neu eingefügte Form.

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

addTable(rowCount, columnCount, options)

Fügt der Folie eine Tabelle hinzu. Gibt ein Shape -Objekt zurück, das die neue Tabelle darstellt. Verwenden Sie die Shape.table -Eigenschaft, um das Table -Objekt für die Form abzurufen.

addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape;

Parameter

rowCount: number

Anzahl der Zeilen in der Tabelle. Muss 1 oder höher sein.

columnCount: number

Anzahl der Spalten in der Tabelle. Muss 1 oder höher sein.

options: PowerPoint.TableAddOptions

Stellt Optionen bereit, die die neue Tabelle beschreiben.

Gibt zurück

PowerPoint.Shape

Die neu eingefügte Form.

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

Beispiele

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

// Adds a basic table.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;

  // Add a simple table, specifying the row and column count.
  shapes.addTable(3, 4);
  await context.sync();
});

addTextBox(text, options)

Fügt der Folie ein Textfeld mit dem bereitgestellten Text als Inhalt hinzu. Gibt ein Shape -Objekt zurück, das das neue Textfeld darstellt.

addTextBox(text: string, options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;

Parameter

text: string

Gibt den Text an, der im erstellten Textfeld angezeigt wird.

options: PowerPoint.ShapeAddOptions

Ein optionaler Parameter, um die zusätzlichen Optionen anzugeben, z. B. die Position des Textfelds.

Gibt zurück

PowerPoint.Shape

Die neu eingefügte Form.

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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 adds a text box to the collection, while specifying its text,
// location, and size. Then it names the text box.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  const textbox: PowerPoint.Shape = shapes.addTextBox("Hello!", {
    left: 100,
    top: 300,
    height: 300,
    width: 450,
  });
  textbox.name = "Textbox";

  return context.sync();
});

getCount()

Ruft die Anzahl der Shapes in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Die Anzahl der Shapes in der Auflistung.

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

Beispiele

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

// Gets the table from a shape.
await PowerPoint.run(async (context) => {
  const shapes = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  shapes.load("items");
  await context.sync();

  if (shapeCount.value > 0) {
    const shape = shapes.getItemAt(0);
    shape.load("type");
    await context.sync();

    // The shape type can indicate whether the shape is a table.
    const isTable = shape.type === PowerPoint.ShapeType.table;

    if (isTable) {
      // Get the Table object for the Shape which is a table.
      const table = shape.getTable();
      table.load();
      await context.sync();

      // Get the Table row and column count.
      console.log("Table RowCount: " + table.rowCount + " and columnCount: " + table.columnCount);
    } else console.log("Selected shape isn't table.");
  } else console.log("No shape selected.");
});

getItem(key)

Ruft ein Shape unter Verwendung seiner eindeutigen ID ab. Wenn die Form nicht vorhanden ist, wird ein Fehler ausgelöst.

getItem(key: string): PowerPoint.Shape;

Parameter

key: string

Die ID des Shapes.

Gibt zurück

PowerPoint.Shape

Die Form mit der eindeutigen ID. Wenn eine solche Form nicht vorhanden ist, wird ein Fehler ausgelöst.

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

getItemAt(index)

Ruft ein Shape mit seinem nullbasierten Index in der Auflistung ab. Wenn sich der Index außerhalb des zulässigen Bereichs befindet, wird ein Fehler ausgelöst.

getItemAt(index: number): PowerPoint.Shape;

Parameter

index: number

Der Index der Form in der Auflistung.

Gibt zurück

PowerPoint.Shape

Die Form am angegebenen Index. Wenn der Index außerhalb des zulässigen Bereichs liegt, wird ein Fehler ausgelöst.

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

Beispiele

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

await PowerPoint.run(async function (context) {
  const slide: PowerPoint.Slide = context.presentation.slides.getItemAt(0);
  const shape: PowerPoint.Shape = slide.shapes.getItemAt(0);
  shape.tags.add("MOUNTAIN", "Denali");

  await context.sync();

  const myShapeTag: PowerPoint.Tag = shape.tags.getItem("MOUNTAIN");
  myShapeTag.load("key, value");

  await context.sync();

  console.log("Added key " + JSON.stringify(myShapeTag.key) + " with value " + JSON.stringify(myShapeTag.value));
});

getItemOrNullObject(id)

Ruft ein Shape unter Verwendung seiner eindeutigen ID ab. Wenn eine solche Form nicht vorhanden ist, wird ein Objekt zurückgegeben, bei dem eine isNullObject Eigenschaft auf true festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(id: string): PowerPoint.Shape;

Parameter

id: string

Die ID des Shapes.

Gibt zurück

PowerPoint.Shape

Die Form mit der eindeutigen ID. Wenn eine solche Form nicht vorhanden ist, wird ein Objekt zurückgegeben, bei dem eine isNullObject Eigenschaft auf true festgelegt ist.

Hinweise

[ API-Satz: PowerPointApi 1.3 ]

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.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;

Parameter

options: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Gibt zurück

PowerPoint.ShapeCollection

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

PowerPoint.ShapeCollection

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

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?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;

Parameter

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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.ShapeCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.ShapeCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): PowerPoint.Interfaces.ShapeCollectionData;

Gibt zurück

PowerPoint.Interfaces.ShapeCollectionData

Feedback

War diese Seite hilfreich?

Freigeben über

PowerPoint.ShapeCollection class

Hinweise

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

context

Eigenschaftswert

items

Eigenschaftswert

Details zur Methode

addGeometricShape(geometricShapeType, options)

Parameter

Gibt zurück

Hinweise

Beispiele

addGeometricShape(geometricShapeType, options)

Parameter

Gibt zurück

Hinweise

addGroup(values)

Parameter

Gibt zurück

Hinweise

Beispiele

addLine(connectorType, options)

Parameter

Gibt zurück

Hinweise

Beispiele

addLine(connectorType, options)

Parameter

Gibt zurück

Hinweise

addTable(rowCount, columnCount, options)

Parameter

Gibt zurück

Hinweise

Beispiele

addTextBox(text, options)

Parameter

Gibt zurück

Hinweise

Beispiele

getCount()

Gibt zurück

Hinweise

Beispiele

getItem(key)

Parameter

Gibt zurück

Hinweise

getItemAt(index)

Parameter

Gibt zurück

Hinweise

Beispiele

getItemOrNullObject(id)

Parameter

Gibt zurück

Hinweise

load(options)

Parameter

Gibt zurück

load(propertyNames)

Parameter

Gibt zurück

Beispiele

load(propertyNamesAndPaths)

Parameter

Gibt zurück

toJSON()

Gibt zurück

Feedback