Word.Interfaces.TextFrameLoadOptions interface

Represents the text frame of a shape object.

Remarks

[ API set: WordApiDesktop 1.2 ]

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).

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.

hasText

Specifies if the text frame contains text.

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

$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

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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

bottomMargin

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

bottomMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

hasText

Specifies if the text frame contains text.

hasText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

leftMargin

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

leftMargin?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

rightMargin

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

rightMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

topMargin

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

topMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

verticalAlignment

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

verticalAlignment?: boolean;

Property Value

boolean

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 ]