Word.Interfaces.ShapeTextWrapLoadOptions interface

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 all the properties for wrapping text around a 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).
bottomDistance	Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.
leftDistance	Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.
rightDistance	Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.
side	Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.
topDistance	Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.
type	Specifies the text wrap type around the shape. See Word.ShapeTextWrapType for details.

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

bottomDistance

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.

Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.

bottomDistance?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

leftDistance

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.

Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.

leftDistance?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

rightDistance

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.

Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.

rightDistance?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

side

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.

Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.

side?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

topDistance

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.

Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.

topDistance?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

type

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.

Specifies the text wrap type around the shape. See Word.ShapeTextWrapType for details.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]