PowerPoint.SlideScopedCollection class
Представляет коллекцию слайдов в презентации.
- Extends
Комментарии
Используется
Примеры
// 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 | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| export |
Экспортирует все слайды этой коллекции в собственный файл презентации, возвращаемый как данные в кодировке Base64. |
| get |
Получает количество слайдов в коллекции. |
| get |
Получение слайда с уникальным идентификатором. |
| get |
Получает слайд с использованием индекса, отсчитываемого от нуля, в коллекции. |
| get |
Получение слайда с уникальным идентификатором. Если такого слайда нет, возвращается объект со свойством |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: PowerPoint.Slide[];Значение свойства
Сведения о методе
exportAsBase64Presentation()
Экспортирует все слайды этой коллекции в собственный файл презентации, возвращаемый как данные в кодировке Base64.
exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;Возвращаемое значение
OfficeExtension.ClientResult<string>
Строка в кодировке Base64.
Комментарии
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
Идентификатор слайда.
Возвращаемое значение
Слайд с уникальным идентификатором.
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/get-slide-by-id.yaml
// Uses getItemOrNullObject to find a slide by ID within the selected slides.
// If the ID isn't found in the selected slides, the returned object's isNullObject property is true.
// If the ID is found in the selected slides, presentation displays that slide.
await PowerPoint.run(async (context) => {
const slideId = (document.getElementById("slide-id-input") as HTMLInputElement).value.trim();
if (!slideId) {
console.log("Enter a slide ID in the text box first.");
return;
}
const selectedSlides: PowerPoint.SlideScopedCollection = context.presentation.getSelectedSlides();
// getItemOrNullObject returns a Slide object without throwing if the ID isn't found.
const slide: PowerPoint.Slide = selectedSlides.getItemOrNullObject(slideId);
slide.load("id");
await context.sync();
if (slide.isNullObject) {
console.log(`Slide ID "${slideId}" was not found in the selected slides.`);
} else {
console.log(`Slide found in the selected slides.`);
console.log(` ID: ${slide.id}`);
// Switch to the slide.
context.presentation.setSelectedSlides([slide.id]);
await context.sync();
console.log(`Switched to the slide - ID: ${slide.id}`);
}
});
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;