Visio.Interfaces.ShapeCollectionLoadOptions interface

Package:

visio

Represents the Shape Collection.

Remarks

[ API set: 1.1 ]

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	For EACH ITEM in the collection: Shape's identifier.
name	For EACH ITEM in the collection: Shape's name.
select	For EACH ITEM in the collection: Returns true, if shape is selected. User can set true to select the shape explicitly.
text	For EACH ITEM in the collection: Shape's text.
view	For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Shape's identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

name

For EACH ITEM in the collection: Shape's name.

name?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

select

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Shape's text.

text?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

view

For EACH ITEM in the collection: Returns the view of the shape.

view?: Visio.Interfaces.ShapeViewLoadOptions;

Property Value

Visio.Interfaces.ShapeViewLoadOptions

Remarks

[ API set: 1.1 ]