Word.Interfaces.TextFrameData interface
An interface describing the data returned by calling textFrame.toJSON().
Properties
| auto |
Specifies 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 |
Specifies the bottom margin, in points, of the text frame. |
| has |
Returns |
| left |
Specifies the left margin, in points, of the text frame. |
| no |
Specifies whether the text in the text frame shouldn't rotate when the shape is rotated. |
| orientation | Specifies the angle to which the text is oriented for the text frame. See |
| right |
Specifies the right margin, in points, of the text frame. |
| top |
Specifies the top margin, in points, of the text frame. |
| vertical |
Specifies the vertical alignment of the text frame. See |
| word |
Determines whether lines break automatically to fit text inside the shape. |
Property Details
autoSizeSetting
Specifies 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?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";Property Value
Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"
Remarks
bottomMargin
Specifies the bottom margin, in points, of the text frame.
bottomMargin?: number;Property Value
number
Remarks
hasText
Returns true if the text frame contains text, otherwise, false.
hasText?: boolean;Property Value
boolean
Remarks
leftMargin
Specifies the left margin, in points, of the text frame.
leftMargin?: number;Property Value
number
Remarks
noTextRotation
Specifies whether the text in the text frame shouldn't rotate when the shape is rotated.
noTextRotation?: boolean;Property Value
boolean
Remarks
orientation
Specifies the angle to which the text is oriented for the text frame. See Word.ShapeTextOrientation for details.
orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";Property Value
Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"
Remarks
rightMargin
Specifies the right margin, in points, of the text frame.
rightMargin?: number;Property Value
number
Remarks
topMargin
Specifies the top margin, in points, of the text frame.
topMargin?: number;Property Value
number
Remarks
verticalAlignment
Specifies the vertical alignment of the text frame. See Word.ShapeTextVerticalAlignment for details.
verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";Property Value
Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"
Remarks
wordWrap
Determines whether lines break automatically to fit text inside the shape.
wordWrap?: boolean;Property Value
boolean