PowerPoint.BindingCollection class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: PowerPoint.Binding[];

Valeur de propriété

Ajoute une nouvelle liaison à une forme particulière. Si l’ID fourni est déjà utilisé par une liaison, la liaison existante sera remplacée.

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

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Exemples

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

Ajoute une nouvelle liaison à une forme particulière. Si l’ID fourni est déjà utilisé par une liaison, la liaison existante sera remplacée.

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

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Ajoute une nouvelle liaison en fonction de la sélection actuelle. Si la sélection comporte plusieurs zones, l’erreur InvalidReference est renvoyée.

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

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Ajoute une nouvelle liaison en fonction de la sélection actuelle. Si la sélection comporte plusieurs zones, l’erreur InvalidReference est renvoyée.

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

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Obtient le nombre de liaisons de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Obtient un objet de liaison par ID. Lève une exception ItemNotFoundException s’il n’y a pas de liaison avec cet ID.

getItem(key: string): PowerPoint.Binding;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Exemples

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

Obtient un objet de liaison en fonction de sa position dans le tableau d’éléments. Lève une exception InvalidArgumentException si l’index est inférieur à 0 ou supérieur ou égal au nombre d’éléments de la collection.

getItemAt(index: number): PowerPoint.Binding;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Obtient un objet de liaison par ID. Si l’objet de liaison n’existe pas, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getItemOrNullObject(id: string): PowerPoint.Binding;

Paramètres

Retours

Remarques

Jeu d’API : PowerPointApi 1.8

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): PowerPoint.BindingCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.BindingCollection;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine PowerPoint.BindingCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) PowerPoint.Interfaces.BindingCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): PowerPoint.Interfaces.BindingCollectionData;

Retours