Edit

Visio.Interfaces.ShapeLoadOptions interface

Represents the Shape class.

Remarks

API set: 1.1

Used by

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

id

Shape's identifier. Read-only.

name

Shape's name. Read-only.

select

Returns true, if shape is selected. User can set true to select the shape explicitly.

text

Shape's text. Read-only.

view

Returns the view of the shape.

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

id

Shape's identifier. Read-only.

id?: boolean;

Property Value

boolean

Remarks

API set: 1.1

name

Shape's name. Read-only.

name?: boolean;

Property Value

boolean

Remarks

API set: 1.1

select

Returns true, if shape is selected. User can set true to select the shape explicitly.

select?: boolean;

Property Value

boolean

Remarks

API set: 1.1

text

Shape's text. Read-only.

text?: boolean;

Property Value

boolean

Remarks

API set: 1.1

view

Returns the view of the shape.

view?: Visio.Interfaces.ShapeViewLoadOptions;

Property Value

Remarks

API set: 1.1