PowerPoint.ShapeScopedCollection class

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

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: PowerPoint.Shape[];

Eigenschaftswert

Ruft die Anzahl der Shapes in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Die Anzahl der Shapes in der Sammlung.

Hinweise

API-Satz: PowerPointApi 1.5

Beispiele

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

// Gets the shapes you selected on the slide and displays their IDs on the task pane.
await PowerPoint.run(async (context) => {
  let finalTable = "";
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();
  finalTable += "<br>getSelectedShapes.getCount returned:<b>" + shapeCount.value + "</b><br>";
  finalTable +=
    "<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
  shapes.load("items");
  await context.sync();
  shapes.items.map((shape, index) => {
    finalTable += "<tr><td>" + index + "</td><td>" + shape.id + "</td></tr>";
  });
  finalTable += "</table>";
  const outputSpan = document.getElementById("outputSpan");
  outputSpan.innerHTML = "";
  outputSpan.innerHTML += finalTable;
});

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

getItem(key: string): PowerPoint.Shape;

Parameter

Gibt zurück

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

Hinweise

API-Satz: PowerPointApi 1.5

Ruft eine Form mithilfe ihres nullbasierten Indexes in der Auflistung ab. Ein Fehler wird ausgelöst, wenn der Index außerhalb des zulässigen Bereichs liegt.

getItemAt(index: number): PowerPoint.Shape;

Parameter

Gibt zurück

Das Shape am angegebenen Index. Ein Fehler wird ausgelöst, wenn der Index außerhalb des zulässigen Bereichs liegt.

Hinweise

API-Satz: PowerPointApi 1.5

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

getItemOrNullObject(id: string): PowerPoint.Shape;

Parameter

Gibt zurück

Das Shape mit der eindeutigen ID. Wenn eine solche Form nicht vorhanden ist, wird ein Objekt mit der isNullObject auf true festgelegten Eigenschaft zurückgegeben.

Hinweise

API-Satz: PowerPointApi 1.5

Beispiele

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

// Uses getItemOrNullObject to find a shape by ID within the selected shapes.
// If the ID is not found in the selected shapes, the returned object's isNullObject property is true.
await PowerPoint.run(async (context) => {
  const shapeId = (document.getElementById("shape-id-input") as HTMLInputElement).value.trim();
  if (!shapeId) {
    console.log("Enter a shape ID in the text box first.");
    return;
  }

  const selectedShapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();

  // getItemOrNullObject returns a Shape object without throwing if the ID isn't found.
  const shape: PowerPoint.Shape = selectedShapes.getItemOrNullObject(shapeId);
  shape.load("id,name,type");
  await context.sync();

  if (shape.isNullObject) {
    console.log(`Shape ID "${shapeId}" was not found in the selected shapes.`);
  } else {
    console.log(`Shape found in the selected shapes.`);
    console.log(`  ID: ${shape.id}`);
    console.log(`  Name: "${shape.name}"`);
    console.log(`  Type: ${shape.type}`);
  }
});

Gruppiert alle Shapes in dieser Sammlung in einem einzigen Shape. Wenn die Sammlung weniger als zwei Shapes enthält, gibt diese Methode den GeneralException Fehler zurück.

group(): PowerPoint.Shape;

Gibt zurück

Das neu erstellte gruppierte Shape als PowerPoint.Shape.

Hinweise

API-Satz: PowerPointApi 1.8

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

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

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

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 sie übergeben wird.) Während das ursprüngliche PowerPoint.ShapeScopedCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.ShapeScopedCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;

Gibt zurück