Edit

Share via

Excel.Interfaces.TextFrameData interface

  • Reference
Package:
excel

An interface describing the data returned by calling textFrame.toJSON().

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

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?: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Property Value

Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

Remarks

[ API set: ExcelApi 1.9 ]

bottomMargin

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

bottomMargin?: number;

Property Value

number

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?: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";

Property Value

Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"

Remarks

[ API set: ExcelApi 1.9 ]

horizontalOverflow

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

horizontalOverflow?: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";

Property Value

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

Remarks

[ API set: ExcelApi 1.9 ]

leftMargin

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

leftMargin?: number;

Property Value

number

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?: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";

Property Value

Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"

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?: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";

Property Value

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

Remarks

[ API set: ExcelApi 1.9 ]

rightMargin

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

rightMargin?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

topMargin

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

topMargin?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

verticalAlignment

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

verticalAlignment?: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";

Property Value

Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"

Remarks

[ API set: ExcelApi 1.9 ]

verticalOverflow

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

verticalOverflow?: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";

Property Value

Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"

Remarks

[ API set: ExcelApi 1.9 ]