Excel.Interfaces.TextFrameLoadOptions interface

Package:

excel

Represents the text frame of a shape object.

Remarks

[ API set: ExcelApi 1.9 ]

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.
horizontalAlignment	Represents the horizontal alignment of the text frame. See Excel.ShapeTextHorizontalAlignment for details.
horizontalOverflow	Represents the horizontal overflow behavior of the text frame. See Excel.ShapeTextHorizontalOverflow for details.
leftMargin	Represents the left margin, in points, of the text frame.
orientation	Represents the angle to which the text is oriented for the text frame. See Excel.ShapeTextOrientation for details.
readingOrder	Represents the reading order of the text frame, either left-to-right or right-to-left. See Excel.ShapeTextReadingOrder for details.
rightMargin	Represents the right margin, in points, of the text frame.
textRange	Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See Excel.TextRange for details.
topMargin	Represents the top margin, in points, of the text frame.
verticalAlignment	Represents the vertical alignment of the text frame. See Excel.ShapeTextVerticalAlignment for details.
verticalOverflow	Represents the vertical overflow behavior of the text frame. See Excel.ShapeTextVerticalOverflow for details.

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: ExcelApi 1.9 ]

bottomMargin

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

bottomMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

hasText

Specifies if the text frame contains text.

hasText?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

horizontalAlignment

Represents the horizontal alignment of the text frame. See Excel.ShapeTextHorizontalAlignment for details.

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

horizontalOverflow

Represents the horizontal overflow behavior of the text frame. See Excel.ShapeTextHorizontalOverflow for details.

horizontalOverflow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

leftMargin

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

leftMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

orientation

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

orientation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

readingOrder

Represents the reading order of the text frame, either left-to-right or right-to-left. See Excel.ShapeTextReadingOrder for details.

readingOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

rightMargin

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

rightMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

textRange

Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See Excel.TextRange for details.

textRange?: Excel.Interfaces.TextRangeLoadOptions;

Property Value

Excel.Interfaces.TextRangeLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

topMargin

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

topMargin?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

verticalAlignment

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

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

verticalOverflow

Represents the vertical overflow behavior of the text frame. See Excel.ShapeTextVerticalOverflow for details.

verticalOverflow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]