PowerPoint.Interfaces.ShapeLoadOptions interface

Represents a single shape in the slide.

Remarks

[ API set: PowerPointApi 1.3 ]

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

Returns the fill formatting of this shape.

height

Specifies the height, in points, of the shape. Throws an InvalidArgument exception when set with a negative value.

id

Gets the unique ID of the shape.

left

The distance, in points, from the left side of the shape to the left side of the slide.

lineFormat

Returns the line formatting of this shape.

name

Specifies the name of this shape.

textFrame

Returns the text frame object of this shape.

top

The distance, in points, from the top edge of the shape to the top edge of the slide.

type

Returns the type of this shape. See PowerPoint.ShapeType for details.

width

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

Returns the fill formatting of this shape.

fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;

Property Value

Remarks

[ API set: PowerPointApi 1.4 ]

height

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

Gets the unique ID of the shape.

id?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.3 ]

left

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

Returns the line formatting of this shape.

lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;

Property Value

Remarks

[ API set: PowerPointApi 1.4 ]

name

Specifies the name of this shape.

name?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

textFrame

Returns the text frame object of this shape.

textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;

Property Value

Remarks

[ API set: PowerPointApi 1.4 ]

top

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

Returns the type of this shape. See PowerPoint.ShapeType for details.

type?: boolean;

Property Value

boolean

Remarks

[ API set: PowerPointApi 1.4 ]

width

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 ]