PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions interface
Represents a collection of shapes.
Remarks
Properties
| $all | Specifying |
| adjustments | For EACH ITEM in the collection: Returns an |
| alt |
For EACH ITEM in the collection: The alt text description of the Shape. Alt text provides alternative, text-based representations of the information contained in the Shape. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. |
| alt |
For EACH ITEM in the collection: The alt text title of the Shape. Alt text provides alternative, text-based representations of the information contained in the Shape. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content. |
| creation |
For EACH ITEM in the collection: Gets the creation ID of the shape. Returns |
| fill | For EACH ITEM in the collection: Returns the fill formatting of this shape. |
| group | For EACH ITEM in the collection: Returns the |
| height | For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an |
| id | For EACH ITEM in the collection: Gets the unique ID of the shape. |
| is |
For EACH ITEM in the collection: Represents whether the shape is decorative or not. Decorative objects add visual interest but aren't informative (e.g. stylistic borders). People using screen readers will hear these are decorative so they know they aren't missing any important information. |
| left | For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide. |
| level | For EACH ITEM in the collection: Returns the level of the specified shape.
|
| line |
For EACH ITEM in the collection: Returns the line formatting of this shape. |
| name | For EACH ITEM in the collection: Specifies the name of this shape. |
| parent |
For EACH ITEM in the collection: Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the |
| placeholder |
For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. If the shape type isn't |
| rotation | For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis. A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation. |
| text |
For EACH ITEM in the collection: Returns the PowerPoint.TextFrame object of this |
| top | For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide. |
| type | For EACH ITEM in the collection: Returns the type of this shape. See PowerPoint.ShapeType for details. |
| visible | For EACH ITEM in the collection: Specifies if the shape is visible. |
| width | For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an |
| z |
For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number. |
Property Details
$all
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
adjustments
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Returns an Adjustments object that contains adjustment values for all the adjustments in this shape.
adjustments?: PowerPoint.Interfaces.AdjustmentsLoadOptions;Property Value
Remarks
altTextDescription
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: The alt text description of the Shape.
Alt text provides alternative, text-based representations of the information contained in the Shape. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
altTextDescription?: boolean;Property Value
boolean
Remarks
altTextTitle
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: The alt text title of the Shape.
Alt text provides alternative, text-based representations of the information contained in the Shape. This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape. A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
altTextTitle?: boolean;Property Value
boolean
Remarks
creationId
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Gets the creation ID of the shape. Returns null if the shape has no creation ID.
creationId?: boolean;Property Value
boolean
Remarks
fill
For EACH ITEM in the collection: Returns the fill formatting of this shape.
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;Property Value
Remarks
group
For EACH ITEM in the collection: Returns the ShapeGroup associated with the shape. If the shape type isn't group, then this method returns the GeneralException error.
group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;Property Value
Remarks
height
For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an InvalidArgument exception when set with a negative value.
height?: boolean;Property Value
boolean
Remarks
id
For EACH ITEM in the collection: Gets the unique ID of the shape.
id?: boolean;Property Value
boolean
Remarks
isDecorative
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Represents whether the shape is decorative or not.
Decorative objects add visual interest but aren't informative (e.g. stylistic borders). People using screen readers will hear these are decorative so they know they aren't missing any important information.
isDecorative?: boolean;Property Value
boolean
Remarks
left
For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
left?: boolean;Property Value
boolean
Remarks
level
For EACH ITEM in the collection: Returns the level of the specified shape.
A level of 0 means the shape isn't part of a group.
A level of 1 means the shape is part of a top-level group.
A level greater than 1 indicates the shape is a nested group.
level?: boolean;Property Value
boolean
Remarks
lineFormat
For EACH ITEM in the collection: Returns the line formatting of this shape.
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;Property Value
Remarks
name
For EACH ITEM in the collection: Specifies the name of this shape.
name?: boolean;Property Value
boolean
Remarks
parentGroup
For EACH ITEM in the collection: Returns the parent group of this shape. If the shape isn't part of a group, then this method returns the GeneralException error.
parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;Property Value
Remarks
placeholderFormat
For EACH ITEM in the collection: Returns the properties that apply specifically to this placeholder. If the shape type isn't placeholder, then this method returns the GeneralException error.
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;Property Value
Remarks
rotation
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis. A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
rotation?: boolean;Property Value
boolean
Remarks
textFrame
For EACH ITEM in the collection: Returns the PowerPoint.TextFrame object of this Shape. Throws an InvalidArgument exception if the shape doesn't support a TextFrame.
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;Property Value
Remarks
top
For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
top?: boolean;Property Value
boolean
Remarks
type
For EACH ITEM in the collection: Returns the type of this shape. See PowerPoint.ShapeType for details.
type?: boolean;Property Value
boolean
Remarks
visible
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
For EACH ITEM in the collection: Specifies if the shape is visible.
visible?: boolean;Property Value
boolean
Remarks
width
For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an InvalidArgument exception when set with a negative value.
width?: boolean;Property Value
boolean
Remarks
zOrderPosition
For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
zOrderPosition?: boolean;Property Value
boolean