Edit

Share via

Word.Interfaces.CanvasLoadOptions interface

  • Reference
Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets an integer that represents the canvas identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

shape

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the Shape object associated with the canvas.

shape?: Word.Interfaces.ShapeLoadOptions;

Property Value

Word.Interfaces.ShapeLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]