Поделиться через

PowerPoint.SlideMasterCollection class

  • Ссылка
Пакет:
powerpoint

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: PowerPointApi 1.3 ]

Свойства

context

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

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

Методы

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.SlideMasterCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.SlideMasterCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.SlideMaster[];

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

PowerPoint.SlideMaster[]

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

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

getItem(key)

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

getItem(key: string): PowerPoint.SlideMaster;

Параметры

key

string

Идентификатор образца слайдов.

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

PowerPoint.SlideMaster

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

getItemAt(index)

Возвращает образец слайдов, используя отсчитываемый от нуля индекс в коллекции.

getItemAt(index: number): PowerPoint.SlideMaster;

Параметры

index

number

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

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

PowerPoint.SlideMaster

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

getItemOrNullObject(id)

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

getItemOrNullObject(id: string): PowerPoint.SlideMaster;

Параметры

id

string

Идентификатор образца слайдов.

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

PowerPoint.SlideMaster

Образец слайдов с уникальным идентификатором.

Комментарии

[ Набор API: PowerPointApi 1.3 ]

load(options)

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

load(options?: PowerPoint.Interfaces.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideMasterCollection;

Параметры

options

PowerPoint.Interfaces.SlideMasterCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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

PowerPoint.SlideMasterCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.SlideMasterCollection

Примеры

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

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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

PowerPoint.SlideMasterCollection

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideMasterCollectionData;

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

PowerPoint.Interfaces.SlideMasterCollectionData