PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions interface

Package:

powerpoint

Represents a collection of shapes.

Remarks

[ API set: PowerPointApi 1.3 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
fill	For EACH ITEM in the collection: Returns the fill formatting of this shape.
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.
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.
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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: 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.4 ]

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 ]

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.4 ]

name

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

name?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

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.4 ]

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 ]