PowerPoint.ShapeScopedCollection 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
// Changes the selected shapes fill color to red.
await PowerPoint.run(async (context) => {
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
shapes.load("items/fill/type");
await context.sync();
shapes.items.map((shape) => {
const shapeFillType = shape.fill.type as PowerPoint.ShapeFillType;
console.log(`Shape ID ${shape.id} original fill type: ${shapeFillType}`);
shape.fill.setSolidColor("red");
});
await context.sync();
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| get |
Возвращает количество фигур в коллекции. |
| get |
Получает фигуру, используя ее уникальный идентификатор. Если фигура не существует, возникает ошибка. |
| get |
Возвращает фигуру, используя отсчитываемый от нуля индекс в коллекции. Если индекс выходит за пределы диапазона, возникает ошибка. |
| get |
Получает фигуру, используя ее уникальный идентификатор. Если такая фигура не существует, возвращается объект со свойством |
| group() | Группирует все фигуры в этой коллекции в одну фигуру. Если коллекция содержит менее двух фигур, этот метод возвращает ошибку |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: PowerPoint.Shape[];Значение свойства
Сведения о методе
getCount()
Возвращает количество фигур в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Количество фигур в коллекции.
Комментарии
[ Набор API: PowerPointApi 1.5 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-set-shapes.yaml
// Gets the shapes you selected on the slide and displays their IDs on the task pane.
await PowerPoint.run(async (context) => {
let finalTable = "";
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
await context.sync();
finalTable += "<br>getSelectedShapes.getCount returned:<b>" + shapeCount.value + "</b><br>";
finalTable +=
"<br><table border=1 cellpadding=3 cellspacing=0><tr><td bgcolor=#3333EE><font color=white>Index</font></td><td bgcolor=#3333EE><font color=white>Id</font></td></tr>";
shapes.load("items");
await context.sync();
shapes.items.map((shape, index) => {
finalTable += "<tr><td>" + index + "</td><td>" + shape.id + "</td></tr>";
});
finalTable += "</table>";
const outputSpan = document.getElementById("outputSpan");
outputSpan.innerHTML = "";
outputSpan.innerHTML += finalTable;
});
getItem(key)
Получает фигуру, используя ее уникальный идентификатор. Если фигура не существует, возникает ошибка.
getItem(key: string): PowerPoint.Shape;Параметры
- key
-
string
Идентификатор фигуры.
Возвращаемое значение
Фигура с уникальным идентификатором. Если такая фигура не существует, возникает ошибка.
Комментарии
getItemAt(index)
Возвращает фигуру, используя отсчитываемый от нуля индекс в коллекции. Если индекс выходит за пределы диапазона, возникает ошибка.
getItemAt(index: number): PowerPoint.Shape;Параметры
- index
-
number
Индекс фигуры в коллекции.
Возвращаемое значение
Фигура по заданному индексу. Если индекс выходит за пределы диапазона, возникает ошибка.
Комментарии
getItemOrNullObject(id)
Получает фигуру, используя ее уникальный идентификатор. Если такая фигура не существует, возвращается объект со свойством isNullObject true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(id: string): PowerPoint.Shape;Параметры
- id
-
string
Идентификатор фигуры.
Возвращаемое значение
Фигура с уникальным идентификатором. Если такая фигура не существует, возвращается объект со свойством isNullObject true.
Комментарии
group()
Группирует все фигуры в этой коллекции в одну фигуру. Если коллекция содержит менее двух фигур, этот метод возвращает ошибку GeneralException .
group(): PowerPoint.Shape;Возвращаемое значение
Только что созданная сгруппированная фигура в виде PowerPoint.Shape.
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;Параметры
- options
-
PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.ShapeScopedCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.ShapeScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.ShapeScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;