PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions interface

Package:

powerpoint

Represents a collection of shapes.

Remarks

[ API set: PowerPointApi 1.5 ]

Properties

$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).
fill	For EACH ITEM in the collection: Returns the fill formatting of this shape.
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.
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.
id	For EACH ITEM in the collection: Gets the unique ID of the shape.
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. 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.
lineFormat	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.
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.
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.
textFrame	For EACH ITEM in the collection: Returns the text frame object of this shape.
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.
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.

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

fill

For EACH ITEM in the collection: Returns the fill formatting of this shape.

fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;

Property Value

PowerPoint.Interfaces.ShapeFillLoadOptions

Remarks

[ API set: PowerPointApi 1.5 ]

group

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 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

PowerPoint.Interfaces.ShapeGroupLoadOptions

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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

[ API set: PowerPointApi 1.4 ]

id

For EACH ITEM in the collection: Gets the unique ID of the shape.

id?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.3 ]

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

[ API set: PowerPointApi 1.4 ]

level

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 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

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

lineFormat

For EACH ITEM in the collection: Returns the line formatting of this shape.

lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;

Property Value

PowerPoint.Interfaces.ShapeLineFormatLoadOptions

Remarks

[ API set: PowerPointApi 1.5 ]

name

For EACH ITEM in the collection: Specifies the name of this shape.

name?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

parentGroup

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 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

PowerPoint.Interfaces.ShapeLoadOptions

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

placeholderFormat

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 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

PowerPoint.Interfaces.PlaceholderFormatLoadOptions

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

textFrame

For EACH ITEM in the collection: Returns the text frame object of this shape.

textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;

Property Value

PowerPoint.Interfaces.TextFrameLoadOptions

Remarks

[ API set: PowerPointApi 1.5 ]

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

[ API set: PowerPointApi 1.4 ]

type

For EACH ITEM in the collection: Returns the type of this shape. See PowerPoint.ShapeType for details.

type?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

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

[ API set: PowerPointApi 1.4 ]