PowerPoint.SlideScopedCollection class
Представляет коллекцию слайдов в презентации.
- Extends
Комментарии
[ Набор API: PowerPointApi 1.5 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Saves which shapes are selected so that they can be reselected later.
await PowerPoint.run(async (context) => {
context.presentation.load("slides");
await context.sync();
const slides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
const slideCount = slides.getCount();
slides.load("items");
await context.sync();
savedSlideSelection = [];
slides.items.map((slide) => {
savedSlideSelection.push(slide.id);
});
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items");
await context.sync();
shapes.items.map((shape) => {
savedShapeSelection.push(shape.id);
});
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| get |
Возвращает количество слайдов в коллекции. |
| get |
Получает слайд, используя его уникальный идентификатор. |
| get |
Получает слайд, используя отсчитываемый от нуля индекс в коллекции. |
| get |
Получает слайд, используя его уникальный идентификатор. Если такой слайд не существует, возвращается объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: PowerPoint.Slide[];Значение свойства
Сведения о методе
getCount()
Возвращает количество слайдов в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Количество слайдов в коллекции.
Комментарии
getItem(key)
Получает слайд, используя его уникальный идентификатор.
getItem(key: string): PowerPoint.Slide;Параметры
- key
-
string
Идентификатор слайда.
Возвращаемое значение
Слайд с уникальным идентификатором. Если такой слайд не существует, возникает ошибка.
Комментарии
getItemAt(index)
Получает слайд, используя отсчитываемый от нуля индекс в коллекции.
getItemAt(index: number): PowerPoint.Slide;Параметры
- index
-
number
Индекс слайда в коллекции.
Возвращаемое значение
Слайд по заданному индексу. Если индекс выходит за пределы диапазона, возникает ошибка.
Комментарии
getItemOrNullObject(id)
Получает слайд, используя его уникальный идентификатор. Если такой слайд не существует, возвращается объект со свойством isNullObject true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(id: string): PowerPoint.Slide;Параметры
- id
-
string
Идентификатор слайда.
Возвращаемое значение
Слайд с уникальным идентификатором.
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;Параметры
- options
-
PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SlideScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.SlideScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;Возвращаемое значение
Office Add-ins