PowerPoint.BindingCollection class

Представляет коллекцию всех объектов привязки, являющихся частью презентации.

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

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

add(shape, bindingType, id)	Добавляет новую привязку к определенной фигуре. Если указанный идентификатор уже используется привязкой, существующая привязка будет перезаписана.
add(shape, bindingType, id)	Добавляет новую привязку к определенной фигуре. Если указанный идентификатор уже используется привязкой, существующая привязка будет перезаписана.
addFromSelection(bindingType, id)	Добавляет новую привязку на основе текущего выделенного фрагмента. Если выделенный фрагмент содержит несколько областей, будет возвращена `InvalidReference` ошибка.
addFromSelection(bindingType, id)	Добавляет новую привязку на основе текущего выделенного фрагмента. Если выделенный фрагмент содержит несколько областей, будет возвращена `InvalidReference` ошибка.
getCount()	Получает количество привязок в коллекции.
getItem(key)	Возвращает объект привязки по идентификатору. Выдает исключение ItemNotFoundException, если привязка к этому идентификатору отсутствует.
getItemAt(index)	Возвращает объект привязки с учетом его положения в массиве элементов. Создает исключение InvalidArgumentException, если индекс меньше 0 либо больше или равен количеству элементов в коллекции.
getItemOrNullObject(id)	Возвращает объект привязки по идентификатору. Если объекта привязки не существует, этот метод возвращает объект со свойством `isNullObjecttrue`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `PowerPoint.BindingCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `PowerPoint.Interfaces.BindingCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

PowerPoint.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: PowerPoint.Binding[];

Значение свойства

PowerPoint.Binding[]

add(shape, bindingType, id)

Добавляет новую привязку к определенной фигуре. Если указанный идентификатор уже используется привязкой, существующая привязка будет перезаписана.

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

Параметры

shape: PowerPoint.Shape

Фигура, к которой добавляется привязка.

bindingType: PowerPoint.BindingType

Тип привязки. См.BindingType

id: string

Идентификатор привязки.

Возвращаемое значение

PowerPoint.Binding

Примеры

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

Добавляет новую привязку к определенной фигуре. Если указанный идентификатор уже используется привязкой, существующая привязка будет перезаписана.

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

Параметры

shape: PowerPoint.Shape

Фигура, к которой добавляется привязка.

bindingType: "Shape"

Тип привязки. См.BindingType

id: string

Идентификатор привязки.

Возвращаемое значение

PowerPoint.Binding

addFromSelection(bindingType, id)

Добавляет новую привязку на основе текущего выделенного фрагмента. Если выделенный фрагмент содержит несколько областей, будет возвращена InvalidReference ошибка.

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

Параметры

bindingType: PowerPoint.BindingType

Тип привязки. См.BindingType

id: string

Идентификатор привязки.

Возвращаемое значение

PowerPoint.Binding

addFromSelection(bindingType, id)

Добавляет новую привязку на основе текущего выделенного фрагмента. Если выделенный фрагмент содержит несколько областей, будет возвращена InvalidReference ошибка.

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

Параметры

bindingType: "Shape"

Тип привязки. См.BindingType

id: string

Идентификатор привязки.

Возвращаемое значение

PowerPoint.Binding

getCount()

Получает количество привязок в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

OfficeExtension.ClientResult<number>

getItem(key)

Возвращает объект привязки по идентификатору. Выдает исключение ItemNotFoundException, если привязка к этому идентификатору отсутствует.

getItem(key: string): PowerPoint.Binding;

Параметры

key: string

Идентификатор получаемого объекта привязки.

Возвращаемое значение

PowerPoint.Binding

Примеры

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

Возвращает объект привязки с учетом его положения в массиве элементов. Создает исключение InvalidArgumentException, если индекс меньше 0 либо больше или равен количеству элементов в коллекции.

getItemAt(index: number): PowerPoint.Binding;

Параметры

index: number

Значение индекса получаемого объекта. Используется нулевой индекс.

Возвращаемое значение

PowerPoint.Binding

getItemOrNullObject(id)

Возвращает объект привязки по идентификатору. Если объекта привязки не существует, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(id: string): PowerPoint.Binding;

Параметры

id: string

Идентификатор получаемого объекта привязки.

Возвращаемое значение

PowerPoint.Binding

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

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

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

PowerPoint.BindingCollection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

PowerPoint.BindingCollection

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

PowerPoint.BindingCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.BindingCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.BindingCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): PowerPoint.Interfaces.BindingCollectionData;

Возвращаемое значение

PowerPoint.Interfaces.BindingCollectionData

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

context

Значение свойства

items

Значение свойства

Сведения о методе

add(shape, bindingType, id)

Параметры

Возвращаемое значение

Комментарии

Примеры

add(shape, bindingType, id)

Параметры

Возвращаемое значение

Комментарии

addFromSelection(bindingType, id)

Параметры

Возвращаемое значение

Комментарии

addFromSelection(bindingType, id)

Параметры

Возвращаемое значение

Комментарии

getCount()

Возвращаемое значение

Комментарии

getItem(key)

Параметры

Возвращаемое значение

Комментарии

Примеры

getItemAt(index)

Параметры

Возвращаемое значение

Комментарии

getItemOrNullObject(id)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

Обратная связь