PowerPoint.BindingCollection class

Paquete:

powerpoint

Representa la colección de todos los objetos de enlace que forman parte de la presentación.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

Ejemplos

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

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

add(shape, bindingType, id)	Agrega un nuevo enlace a una forma determinada. Si un enlace ya usa el identificador proporcionado, se sobrescribirá el enlace existente.
add(shape, bindingType, id)	Agrega un nuevo enlace a una forma determinada. Si un enlace ya usa el identificador proporcionado, se sobrescribirá el enlace existente.
addFromSelection(bindingType, id)	Agrega un nuevo enlace basado en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.
addFromSelection(bindingType, id)	Agrega un nuevo enlace basado en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.
getCount()	Obtiene el número de enlaces de la colección.
getItem(key)	Obtiene un objeto de enlace por identificador. Produce una excepción ItemNotFoundException si no hay ningún enlace con ese identificador.
getItemAt(index)	Obtiene un objeto de enlace según su posición en la matriz de elementos. Produce una excepción InvalidArgumentException si el índice es menor que 0 o mayor o igual que el número de elementos de la colección.
getItemOrNullObject(id)	Obtiene un objeto de enlace por identificador. Si el objeto de enlace no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.BindingCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.BindingCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

PowerPoint.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: PowerPoint.Binding[];

Valor de propiedad

PowerPoint.Binding[]

Detalles del método

add(shape, bindingType, id)

Agrega un nuevo enlace a una forma determinada. Si un enlace ya usa el identificador proporcionado, se sobrescribirá el enlace existente.

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

Parámetros

shape

PowerPoint.Shape

Forma a la que se agrega el enlace.

bindingType

PowerPoint.BindingType

Tipo de enlace. Consulte BindingType.

id

string

Identificador del enlace.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

Ejemplos

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

Agrega un nuevo enlace a una forma determinada. Si un enlace ya usa el identificador proporcionado, se sobrescribirá el enlace existente.

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

Parámetros

shape

PowerPoint.Shape

Forma a la que se agrega el enlace.

bindingType

"Shape"

Tipo de enlace. Consulte BindingType.

id

string

Identificador del enlace.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

Agrega un nuevo enlace basado en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.

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

Parámetros

bindingType

PowerPoint.BindingType

Tipo de enlace. Consulte BindingType.

id

string

Identificador del enlace.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

Agrega un nuevo enlace basado en la selección actual. Si la selección tiene varias áreas, se devolverá el InvalidReference error.

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

Parámetros

bindingType

"Shape"

Tipo de enlace. Consulte BindingType.

id

string

Identificador del enlace.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

getCount()

Obtiene el número de enlaces de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

getItem(key)

Obtiene un objeto de enlace por identificador. Produce una excepción ItemNotFoundException si no hay ningún enlace con ese identificador.

getItem(key: string): PowerPoint.Binding;

Parámetros

key

string

Identificador del objeto de contenido que se va a recuperar.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

Ejemplos

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

Obtiene un objeto de enlace según su posición en la matriz de elementos. Produce una excepción InvalidArgumentException si el índice es menor que 0 o mayor o igual que el número de elementos de la colección.

getItemAt(index: number): PowerPoint.Binding;

Parámetros

index

number

Valor de índice del objeto que se va a recuperar. Indizado con cero.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

getItemOrNullObject(id)

Obtiene un objeto de enlace por identificador. Si el objeto de enlace no existe, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getItemOrNullObject(id: string): PowerPoint.Binding;

Parámetros

id

string

Identificador del objeto de contenido que se va a recuperar.

Devoluciones

PowerPoint.Binding

Comentarios

[ Conjunto de API: PowerPointApi 1.8 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options

PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

PowerPoint.BindingCollection

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

PowerPoint.BindingCollection

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

PowerPoint.BindingCollection

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original PowerPoint.BindingCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.Interfaces.BindingCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): PowerPoint.Interfaces.BindingCollectionData;

Devoluciones

PowerPoint.Interfaces.BindingCollectionData