Excel.Interfaces.TextFrameLoadOptions interface

Represents the text frame of a shape object.

[ API set: ExcelApi 1.9 ]

Properties

$all
autoSizeSetting

Gets or sets 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.

[ API set: ExcelApi 1.9 ]

bottomMargin

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

[ API set: ExcelApi 1.9 ]

hasText

Specifies whether the text frame contains text.

[ API set: ExcelApi 1.9 ]

horizontalAlignment

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

[ API set: ExcelApi 1.9 ]

horizontalOverflow

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

[ API set: ExcelApi 1.9 ]

leftMargin

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

[ API set: ExcelApi 1.9 ]

orientation

Represents the text orientation of the text frame. See Excel.ShapeTextOrientation for details.

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

[ API set: ExcelApi 1.9 ]

rightMargin

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

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

[ API set: ExcelApi 1.9 ]

topMargin

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

[ API set: ExcelApi 1.9 ]

verticalAlignment

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

[ API set: ExcelApi 1.9 ]

verticalOverflow

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

[ API set: ExcelApi 1.9 ]

Property Details

$all

$all?: boolean;

Property Value

boolean

autoSizeSetting

Gets or sets 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.

[ API set: ExcelApi 1.9 ]

autoSizeSetting?: boolean;

Property Value

boolean

bottomMargin

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

[ API set: ExcelApi 1.9 ]

bottomMargin?: boolean;

Property Value

boolean

hasText

Specifies whether the text frame contains text.

[ API set: ExcelApi 1.9 ]

hasText?: boolean;

Property Value

boolean

horizontalAlignment

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

[ API set: ExcelApi 1.9 ]

horizontalAlignment?: boolean;

Property Value

boolean

horizontalOverflow

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

[ API set: ExcelApi 1.9 ]

horizontalOverflow?: boolean;

Property Value

boolean

leftMargin

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

[ API set: ExcelApi 1.9 ]

leftMargin?: boolean;

Property Value

boolean

orientation

Represents the text orientation of the text frame. See Excel.ShapeTextOrientation for details.

[ API set: ExcelApi 1.9 ]

orientation?: boolean;

Property Value

boolean

readingOrder

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

[ API set: ExcelApi 1.9 ]

readingOrder?: boolean;

Property Value

boolean

rightMargin

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

[ API set: ExcelApi 1.9 ]

rightMargin?: boolean;

Property Value

boolean

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.

[ API set: ExcelApi 1.9 ]

textRange?: Excel.Interfaces.TextRangeLoadOptions;

Property Value

topMargin

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

[ API set: ExcelApi 1.9 ]

topMargin?: boolean;

Property Value

boolean

verticalAlignment

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

[ API set: ExcelApi 1.9 ]

verticalAlignment?: boolean;

Property Value

boolean

verticalOverflow

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

[ API set: ExcelApi 1.9 ]

verticalOverflow?: boolean;

Property Value

boolean