PowerPoint.BindingCollection class

Représente l’ensemble de tous les objets de liaison qui font partie de la présentation.

Remarques

Utilisateur

PowerPoint.Presentation : liaisons

Exemples

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

Propriétés

context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(shape, bindingType, id)	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, bindingType, id)	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.
addFromSelection(bindingType, id)	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, id)	Ajoute une nouvelle liaison en fonction de la sélection actuelle. Si la sélection comporte plusieurs zones, l’erreur `InvalidReference` est renvoyée.
getCount()	Obtient le nombre de liaisons de la collection.
getItem(key)	Obtient un objet de liaison par ID. Lève une exception ItemNotFoundException s’il n’y a pas de liaison avec cet ID.
getItemAt(index)	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.
getItemOrNullObject(id)	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.
load(options)	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)	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)	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.
toJSON()	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.BindingCollectionData`qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

context

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é

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.Binding[];

Valeur de propriété

PowerPoint.Binding[]

add(shape, bindingType, id)

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

shape: PowerPoint.Shape

Forme à laquelle la liaison est ajoutée.

bindingType: PowerPoint.BindingType

Type de liaison. Voir BindingType (en anglais).

id: string

ID de la liaison.

Retours

PowerPoint.Binding

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

add(shape, bindingType, id)

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

shape: PowerPoint.Shape

Forme à laquelle la liaison est ajoutée.

bindingType: "Shape"

Type de liaison. Voir BindingType (en anglais).

id: string

ID de la liaison.

Retours

PowerPoint.Binding

Remarques

Jeu d’API : PowerPointApi 1.8

addFromSelection(bindingType, id)

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

bindingType: PowerPoint.BindingType

Type de liaison. Voir BindingType (en anglais).

id: string

ID de la liaison.

Retours

PowerPoint.Binding

Remarques

Jeu d’API : PowerPointApi 1.8

addFromSelection(bindingType, id)

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

bindingType: "Shape"

Type de liaison. Voir BindingType (en anglais).

id: string

ID de la liaison.

Retours

PowerPoint.Binding

Remarques

Jeu d’API : PowerPointApi 1.8

getCount()

Obtient le nombre de liaisons de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

Jeu d’API : PowerPointApi 1.8

getItem(key)

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

key: string

ID de l’objet de liaison à récupérer.

Retours

PowerPoint.Binding

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

getItemAt(index)

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

index: number

Valeur d’indice de l’objet à récupérer. Avec indice zéro.

Retours

PowerPoint.Binding

Remarques

Jeu d’API : PowerPointApi 1.8

getItemOrNullObject(id)

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

id: string

ID de l’objet de liaison à récupérer.

Retours

PowerPoint.Binding

Remarques

Jeu d’API : PowerPointApi 1.8

load(options)

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

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

Fournit des options pour les propriétés de l’objet à charger.

Retours

PowerPoint.BindingCollection

load(propertyNames)

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

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

PowerPoint.BindingCollection

load(propertyNamesAndPaths)

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

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

PowerPoint.BindingCollection

toJSON()

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

PowerPoint.Interfaces.BindingCollectionData

Remarques

Utilisateur

Exemples

Propriétés

Méthodes

Détails de la propriété

context

Valeur de propriété

items

Valeur de propriété

Détails de la méthode

add(shape, bindingType, id)

Paramètres

Retours

Remarques

Exemples

add(shape, bindingType, id)

Paramètres

Retours

Remarques

addFromSelection(bindingType, id)

Paramètres

Retours

Remarques

addFromSelection(bindingType, id)

Paramètres

Retours

Remarques

getCount()

Retours

Remarques

getItem(key)

Paramètres

Retours

Remarques

Exemples

getItemAt(index)

Paramètres

Retours

Remarques

getItemOrNullObject(id)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Commentaires