PowerPoint.BindingCollection class

Paket:: powerpoint

Stellt die Auflistung aller Bindungsobjekte dar, die Teil der Präsentation sind.

Extends: OfficeExtension.ClientObject

Hinweise

Beispiele

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

// Loads bindings.
await PowerPoint.run(async (context) => {
  const bindings = context.presentation.bindings;
  bindings.load("items");
  await context.sync();

  const bindingCount = bindings.items.length;
  if (bindingCount === 0) {
    console.log(`There are no bindings.`);
  } else if (bindingCount === 1) {
    console.log("There's 1 binding.");
  } else {
    console.log(`There are ${bindingCount} bindings.`);
  }

  bindings.items.forEach((binding) => {
    getShapeForBindingId(binding.id).then((shape) => {
      if (shape) {
        console.log(`Binding ID: ${binding.id} refers to shape ID ${shape.id}`);
      } else {
        console.log(`Binding ID: ${binding.id} doesn't refers to shape.`);
      }
    });
  });

  populateBindingsDropdown(bindings.items);
});

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

add(shape, bindingType, id)	Fügt einer bestimmten Form eine neue Bindung hinzu. Wenn die angegebene ID bereits von einer Bindung verwendet wird, wird die vorhandene Bindung überschrieben.
add(shape, bindingType, id)	Fügt einer bestimmten Form eine neue Bindung hinzu. Wenn die angegebene ID bereits von einer Bindung verwendet wird, wird die vorhandene Bindung überschrieben.
addFromSelection(bindingType, id)	Fügt basierend auf der aktuellen Auswahl eine neue Bindung hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der `InvalidReference` Fehler zurückgegeben.
addFromSelection(bindingType, id)	Fügt basierend auf der aktuellen Auswahl eine neue Bindung hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der `InvalidReference` Fehler zurückgegeben.
getCount()	Ruft die Anzahl der Bindungen in der Sammlung ab.
getItem(key)	Ruft ein binding-Objekt anhand seiner ID ab. Löst eine ItemNotFoundException aus, wenn keine Bindung mit dieser ID besteht.
getItemAt(index)	Ruft ein Binding-Objekt anhand seiner Position im Elementarray ab. Löst eine InvalidArgumentException aus, wenn der Index kleiner als 0 oder größer oder gleich der Anzahl der Elemente in der Auflistung ist.
getItemOrNullObject(id)	Ruft ein binding-Objekt anhand seiner ID ab. Wenn das Bindungsobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen `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.BindingCollection` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `PowerPoint.Interfaces.BindingCollectionData`) 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.Binding[];

Eigenschaftswert

PowerPoint.Binding[]

Details zur Methode

add(shape, bindingType, id)

Fügt einer bestimmten Form eine neue Bindung hinzu. Wenn die angegebene ID bereits von einer Bindung verwendet wird, wird die vorhandene Bindung überschrieben.

add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;

Parameter

shape: PowerPoint.Shape

Form, der die Bindung hinzugefügt wird.

bindingType: PowerPoint.BindingType

Typ der Bindung. Weitere Informationen finden Sie unter BindingType.

id: string

ID der Bindung.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

Beispiele

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

// Inserts an image with binding.
await PowerPoint.run(async (context) => {
  const bindingId = (document.getElementById("temp-binding-id") as HTMLInputElement).value;
  const slide = context.presentation.getSelectedSlides().getItemAt(0);
  const myShape = slide.shapes.addGeometricShape(PowerPoint.GeometricShapeType.rectangle, {
    top: 100,
    left: 30,
    width: 200,
    height: 200
  });

  myShape.fill.setImage(flowerImage);
  context.presentation.bindings.add(myShape, PowerPoint.BindingType.shape, bindingId);
  await context.sync();

  const bindingsDropdown = document.getElementById("bindings-dropdown") as HTMLSelectElement;

  const option = new Option(`Binding ${bindingId}`, bindingId);

  // When a binding ID already exists, the binding is updated to refer to the new shape
  // so select the existing item rather than add a new one.
  const foundIndex = findDropdownItem(bindingsDropdown, option.text);
  if (foundIndex < 0) {
    bindingsDropdown.add(option);
    bindingsDropdown.selectedIndex = bindingsDropdown.options.length - 1;
  } else {
    bindingsDropdown.selectedIndex = foundIndex;
  }
});

add(shape, bindingType, id)

Fügt einer bestimmten Form eine neue Bindung hinzu. Wenn die angegebene ID bereits von einer Bindung verwendet wird, wird die vorhandene Bindung überschrieben.

add(shape: PowerPoint.Shape, bindingType: "Shape", id: string): PowerPoint.Binding;

Parameter

shape: PowerPoint.Shape

Form, der die Bindung hinzugefügt wird.

bindingType: "Shape"

Typ der Bindung. Weitere Informationen finden Sie unter BindingType.

id: string

ID der Bindung.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

Fügt basierend auf der aktuellen Auswahl eine neue Bindung hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der InvalidReference Fehler zurückgegeben.

addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;

Parameter

bindingType: PowerPoint.BindingType

Typ der Bindung. Weitere Informationen finden Sie unter BindingType.

id: string

ID der Bindung.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

Fügt basierend auf der aktuellen Auswahl eine neue Bindung hinzu. Wenn die Auswahl über mehrere Bereiche verfügt, wird der InvalidReference Fehler zurückgegeben.

addFromSelection(bindingType: "Shape", id: string): PowerPoint.Binding;

Parameter

bindingType: "Shape"

Typ der Bindung. Weitere Informationen finden Sie unter BindingType.

id: string

ID der Bindung.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

getCount()

Ruft die Anzahl der Bindungen in der Sammlung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

getItem(key)

Ruft ein binding-Objekt anhand seiner ID ab. Löst eine ItemNotFoundException aus, wenn keine Bindung mit dieser ID besteht.

getItem(key: string): PowerPoint.Binding;

Parameter

key: string

ID des abzurufenden Binding-Objekts.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

Beispiele

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

async function getShapeForBindingId(bindingId: string): Promise<PowerPoint.Shape | undefined> {
  // Gets shape associated with binding ID.
  return PowerPoint.run(async (context) => {
    const binding = context.presentation.bindings.getItem(bindingId);
    const shape = binding.getShape();
    return shape;
  });
}

getItemAt(index)

Ruft ein Binding-Objekt anhand seiner Position im Elementarray ab. Löst eine InvalidArgumentException aus, wenn der Index kleiner als 0 oder größer oder gleich der Anzahl der Elemente in der Auflistung ist.

getItemAt(index: number): PowerPoint.Binding;

Parameter

index: number

Index-Wert des abzurufenden Objekts. Nullindiziert.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

getItemOrNullObject(id)

Ruft ein binding-Objekt anhand seiner ID ab. Wenn das Bindungsobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(id: string): PowerPoint.Binding;

Parameter

id: string

ID des abzurufenden Binding-Objekts.

Gibt zurück

PowerPoint.Binding

Hinweise

[ API-Satz: PowerPointApi 1.8 ]

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

Parameter

options: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

Gibt zurück

PowerPoint.BindingCollection

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

PowerPoint.BindingCollection

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

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

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

toJSON(): PowerPoint.Interfaces.BindingCollectionData;

Gibt zurück

PowerPoint.Interfaces.BindingCollectionData

Feedback

War diese Seite hilfreich?

Freigeben über

PowerPoint.BindingCollection class

Hinweise

Beispiele

Eigenschaften

Methoden

Details zur Eigenschaft

context

Eigenschaftswert

items

Eigenschaftswert

Details zur Methode

add(shape, bindingType, id)

Parameter

Gibt zurück

Hinweise

Beispiele

add(shape, bindingType, id)

Parameter

Gibt zurück

Hinweise

addFromSelection(bindingType, id)

Parameter

Gibt zurück

Hinweise

addFromSelection(bindingType, id)

Parameter

Gibt zurück

Hinweise

getCount()

Gibt zurück

Hinweise

getItem(key)

Parameter

Gibt zurück

Hinweise

Beispiele

getItemAt(index)

Parameter

Gibt zurück

Hinweise

getItemOrNullObject(id)

Parameter

Gibt zurück

Hinweise

load(options)

Parameter

Gibt zurück

load(propertyNames)

Parameter

Gibt zurück

load(propertyNamesAndPaths)

Parameter

Gibt zurück

toJSON()

Gibt zurück

Feedback