Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Word.Interfaces.CanvasLoadOptions interface

Package:
word

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

Remarks

API set: WordApiDesktop 1.2

Used by

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

Remarks

API set: WordApiDesktop 1.2

Feedback

Was this page helpful?