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

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

items

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

readonly items: PowerPoint.SlideLayout[];

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

PowerPoint.SlideLayout[]

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

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

getItem(key)

Возвращает макет с использованием его уникального идентификатора.

getItem(key: string): PowerPoint.SlideLayout;

Параметры

key

string

Идентификатор макета.

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

PowerPoint.SlideLayout

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

getItemAt(index)

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

getItemAt(index: number): PowerPoint.SlideLayout;

Параметры

index

number

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

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

PowerPoint.SlideLayout

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

getItemOrNullObject(id)

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

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

Параметры

id

string

Идентификатор макета.

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

PowerPoint.SlideLayout

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

Комментарии

[ Набор API: PowerPointApi 1.3 ]

load(options)

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

load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;

Параметры

options

PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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

PowerPoint.SlideLayoutCollection

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.SlideLayoutCollection

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

PowerPoint.SlideLayoutCollection

toJSON()

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

toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;

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

PowerPoint.Interfaces.SlideLayoutCollectionData