PowerPoint.BindingCollection class

Pacote:

powerpoint

Representa a coleção de todos os objetos de enlace que fazem parte da apresentação.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

Exemplos

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

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(shape, bindingType, id)	Adiciona um novo enlace a uma forma específica. Se o ID fornecido já estiver a ser utilizado por um enlace, o enlace existente será substituído.
add(shape, bindingType, id)	Adiciona um novo enlace a uma forma específica. Se o ID fornecido já estiver a ser utilizado por um enlace, o enlace existente será substituído.
addFromSelection(bindingType, id)	Adiciona um novo enlace com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o InvalidReference erro.
addFromSelection(bindingType, id)	Adiciona um novo enlace com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o InvalidReference erro.
getCount()	Obtém o número de associações da coleção.
getItem(key)	Obtém um objeto de associação pela ID. Gera um ItemNotFoundException se não existir nenhum enlace com esse ID.
getItemAt(index)	Obtém um objeto de associação com base em sua posição na matriz dos itens. Gera uma InvalidArgumentException se o índice for inferior a 0 ou superior ou igual à contagem de itens na coleção.
getItemOrNullObject(id)	Obtém um objeto de associação pela ID. Se o objeto de enlace não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.BindingCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.BindingCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: PowerPoint.Binding[];

Valor da propriedade

PowerPoint.Binding[]

Detalhes do método

add(shape, bindingType, id)

Adiciona um novo enlace a uma forma específica. Se o ID fornecido já estiver a ser utilizado por um enlace, o enlace existente será substituído.

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

Parâmetros

shape

PowerPoint.Shape

Forma à qual o enlace é adicionado.

bindingType

PowerPoint.BindingType

Tipo de associação. Consulte BindingType.

id

string

ID do enlace.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

Exemplos

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

Adiciona um novo enlace a uma forma específica. Se o ID fornecido já estiver a ser utilizado por um enlace, o enlace existente será substituído.

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

Parâmetros

shape

PowerPoint.Shape

Forma à qual o enlace é adicionado.

bindingType

"Shape"

Tipo de associação. Consulte BindingType.

id

string

ID do enlace.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

Adiciona um novo enlace com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o InvalidReference erro.

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

Parâmetros

bindingType

PowerPoint.BindingType

Tipo de associação. Consulte BindingType.

id

string

ID do enlace.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

addFromSelection(bindingType, id)

Adiciona um novo enlace com base na seleção atual. Se a seleção tiver várias áreas, será devolvido o InvalidReference erro.

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

Parâmetros

bindingType

"Shape"

Tipo de associação. Consulte BindingType.

id

string

ID do enlace.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

getCount()

Obtém o número de associações da coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

getItem(key)

Obtém um objeto de associação pela ID. Gera um ItemNotFoundException se não existir nenhum enlace com esse ID.

getItem(key: string): PowerPoint.Binding;

Parâmetros

key

string

ID do objeto Binding a recuperar.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

Exemplos

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

Obtém um objeto de associação com base em sua posição na matriz dos itens. Gera uma InvalidArgumentException se o índice for inferior a 0 ou superior ou igual à contagem de itens na coleção.

getItemAt(index: number): PowerPoint.Binding;

Parâmetros

index

number

Valor de índice do objeto a ser recuperado. Indexados com zero.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

getItemOrNullObject(id)

Obtém um objeto de associação pela ID. Se o objeto de enlace não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getItemOrNullObject(id: string): PowerPoint.Binding;

Parâmetros

id

string

ID do objeto Binding a recuperar.

Retornos

PowerPoint.Binding

Comentários

[ Conjunto de API: PowerPointApi 1.8 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options

PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

PowerPoint.BindingCollection

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

PowerPoint.BindingCollection

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

PowerPoint.BindingCollection

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.BindingCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.BindingCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): PowerPoint.Interfaces.BindingCollectionData;

Retornos

PowerPoint.Interfaces.BindingCollectionData