Excel.Interfaces.TextFrameLoadOptions interface
Represents the text frame of a shape object.
Remarks
Properties
| $all | Specifying |
| auto |
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. |
| bottom |
Represents the bottom margin, in points, of the text frame. |
| has |
Specifies if the text frame contains text. |
| horizontal |
Represents the horizontal alignment of the text frame. See |
| horizontal |
Represents the horizontal overflow behavior of the text frame. See |
| left |
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 |
| reading |
Represents the reading order of the text frame, either left-to-right or right-to-left. See |
| right |
Represents the right margin, in points, of the text frame. |
| text |
Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text. See |
| top |
Represents the top margin, in points, of the text frame. |
| vertical |
Represents the vertical alignment of the text frame. See |
| vertical |
Represents the vertical overflow behavior of the text frame. See |
Property Details
$all
Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: 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
bottomMargin
Represents the bottom margin, in points, of the text frame.
bottomMargin?: boolean;Property Value
boolean
Remarks
hasText
Specifies if the text frame contains text.
hasText?: boolean;Property Value
boolean
Remarks
horizontalAlignment
Represents the horizontal alignment of the text frame. See Excel.ShapeTextHorizontalAlignment for details.
horizontalAlignment?: boolean;Property Value
boolean
Remarks
horizontalOverflow
Represents the horizontal overflow behavior of the text frame. See Excel.ShapeTextHorizontalOverflow for details.
horizontalOverflow?: boolean;Property Value
boolean
Remarks
leftMargin
Represents the left margin, in points, of the text frame.
leftMargin?: boolean;Property Value
boolean
Remarks
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
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
rightMargin
Represents the right margin, in points, of the text frame.
rightMargin?: boolean;Property Value
boolean
Remarks
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
Remarks
topMargin
Represents the top margin, in points, of the text frame.
topMargin?: boolean;Property Value
boolean
Remarks
verticalAlignment
Represents the vertical alignment of the text frame. See Excel.ShapeTextVerticalAlignment for details.
verticalAlignment?: boolean;Property Value
boolean
Remarks
verticalOverflow
Represents the vertical overflow behavior of the text frame. See Excel.ShapeTextVerticalOverflow for details.
verticalOverflow?: boolean;Property Value
boolean
Remarks
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for