Word.Interfaces.TextFrameUpdateData interface

Package:

word

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

Properties

autoSizeSetting	The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.
bottomMargin	Represents the bottom margin, in points, of the text frame.
leftMargin	Represents the left margin, in points, of the text frame.
noTextRotation	Returns True if text in the text frame shouldn't rotate when the shape is rotated.
orientation	Represents the angle to which the text is oriented for the text frame. See Word.ShapeTextOrientation for details.
rightMargin	Represents the right margin, in points, of the text frame.
topMargin	Represents the top margin, in points, of the text frame.
verticalAlignment	Represents the vertical alignment of the text frame. See Word.ShapeTextVerticalAlignment for details.
wordWrap	Determines whether lines break automatically to fit text inside the shape.

Property Details

autoSizeSetting

The automatic sizing settings for the text frame. A text frame can be set to automatically fit the text to the text frame, to automatically fit the text frame to the text, or not perform any automatic sizing.

autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";

Property Value

Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"

Remarks

[ API set: WordApiDesktop 1.2 ]

bottomMargin

Represents the bottom margin, in points, of the text frame.

bottomMargin?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

leftMargin

Represents the left margin, in points, of the text frame.

leftMargin?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

noTextRotation

Returns True if text in the text frame shouldn't rotate when the shape is rotated.

noTextRotation?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

orientation

Represents the angle to which the text is oriented for the text frame. See Word.ShapeTextOrientation for details.

orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";

Property Value

Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"

Remarks

[ API set: WordApiDesktop 1.2 ]

rightMargin

Represents the right margin, in points, of the text frame.

rightMargin?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

topMargin

Represents the top margin, in points, of the text frame.

topMargin?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.2 ]

verticalAlignment

Represents the vertical alignment of the text frame. See Word.ShapeTextVerticalAlignment for details.

verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";

Property Value

Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"

Remarks

[ API set: WordApiDesktop 1.2 ]

wordWrap

Determines whether lines break automatically to fit text inside the shape.

wordWrap?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]