Edit

Share via

Word.Interfaces.ShapeTextWrapUpdateData interface

  • Reference
Package:
word

An interface for updating data on the ShapeTextWrap object, for use in shapeTextWrap.set({ ... }).

Properties

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

bottomDistance

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

bottomDistance?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

leftDistance

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

leftDistance?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

rightDistance

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

rightDistance?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

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.

side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";

Property Value

Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"

Remarks

[ API set: WordApiDesktop 1.2 ]

topDistance

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

topDistance?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

type

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

type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";

Property Value

Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"

Remarks

[ API set: WordApiDesktop 1.2 ]