Edit

Share via

Word.Interfaces.CanvasLoadOptions interface

  • Reference
Package:
word

Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape.

Remarks

[ API set: WordApiDesktop 1.2 ]

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

Gets an integer that represents the canvas identifier.
shape

Gets the Shape object associated with the canvas.

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

id

Gets an integer that represents the canvas identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

shape

Gets the Shape object associated with the canvas.

shape?: Word.Interfaces.ShapeLoadOptions;

Property Value

Word.Interfaces.ShapeLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]