PowerPoint.SlideCollection class

Пакет:

powerpoint

Представляет коллекцию слайдов в презентации.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.2 ]

Свойства

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

Методы

add(options)	Добавляет новый слайд в конец коллекции.
getCount()	Возвращает количество слайдов в коллекции.
getItem(key)	Получает слайд, используя его уникальный идентификатор.
getItemAt(index)	Получает слайд, используя отсчитываемый от нуля индекс в коллекции. Слайды хранятся в том же порядке, что и в презентации.
getItemOrNullObject(id)	Получает слайд, используя его уникальный идентификатор. Если такой слайд не существует, возвращается объект со свойством isNullObject true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SlideCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.SlideCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.Slide[];

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

PowerPoint.Slide[]

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

add(options)

Добавляет новый слайд в конец коллекции.

add(options?: PowerPoint.AddSlideOptions): void;

Параметры

options

PowerPoint.AddSlideOptions

Параметры, определяющие тему нового слайда.

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

void

Комментарии

[ Набор API: PowerPointApi 1.3 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  context.presentation.slides.add({
    slideMasterId: chosenMaster,
    layoutId: chosenLayout
  });
  await context.sync();
});

getCount()

Возвращает количество слайдов в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Количество слайдов в коллекции.

Комментарии

[ Набор API: PowerPointApi 1.2 ]

getItem(key)

Получает слайд, используя его уникальный идентификатор.

getItem(key: string): PowerPoint.Slide;

Параметры

key

string

Идентификатор слайда.

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

PowerPoint.Slide

Слайд с уникальным идентификатором. Если такой слайд не существует, возникает ошибка.

Комментарии

[ Набор API: PowerPointApi 1.2 ]

getItemAt(index)

Получает слайд, используя отсчитываемый от нуля индекс в коллекции. Слайды хранятся в том же порядке, что и в презентации.

getItemAt(index: number): PowerPoint.Slide;

Параметры

index

number

Индекс слайда в коллекции.

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

PowerPoint.Slide

Слайд по заданному индексу. Если индекс выходит за пределы диапазона, возникает ошибка.

Комментарии

[ Набор API: PowerPointApi 1.2 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-set-slides.yaml

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2 = context.presentation.slides.getItemAt(1);
  const slide4 = context.presentation.slides.getItemAt(3);
  const slide5 = context.presentation.slides.getItemAt(4);
  slide2.load("id");
  slide4.load("id");
  slide5.load("id");
  try {
    await context.sync();
  } catch (error) {
    console.warn("This action requires at least 5 slides in the presentation.");
    return;
  }
  await context.sync();
  context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
  await context.sync();
});

getItemOrNullObject(id)

Получает слайд, используя его уникальный идентификатор. Если такой слайд не существует, возвращается объект со свойством isNullObject true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(id: string): PowerPoint.Slide;

Параметры

id

string

Идентификатор слайда.

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

PowerPoint.Slide

Слайд с уникальным идентификатором.

Комментарии

[ Набор API: PowerPointApi 1.2 ]

load(options)

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

load(options?: PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideCollection;

Параметры

options

PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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

PowerPoint.SlideCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.SlideCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

PowerPoint.SlideCollection

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideCollectionData;

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

PowerPoint.Interfaces.SlideCollectionData