Edit

Share via

Word.Interfaces.TextFrameLoadOptions 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 the text frame of a shape object.

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

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

autoSizeSetting

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.

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: WordApi BETA (PREVIEW ONLY) ]

bottomMargin

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 the bottom margin, in points, of the text frame.

bottomMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

hasText

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 if the text frame contains text.

hasText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

leftMargin

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 the left margin, in points, of the text frame.

leftMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

noTextRotation

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.

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

noTextRotation?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

orientation

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 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: WordApi BETA (PREVIEW ONLY) ]

rightMargin

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 the right margin, in points, of the text frame.

rightMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

topMargin

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 the top margin, in points, of the text frame.

topMargin?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

verticalAlignment

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 the vertical alignment of the text frame. See Word.ShapeTextVerticalAlignment for details.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

wordWrap

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.

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

wordWrap?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]