TextFrame Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the text frame in a Shape object. Contains the text in the text frame as well as the properties that control the margins and orientation of the text frame.
public interface class TextFrame[System.Runtime.InteropServices.Guid("000209B2-0000-0000-C000-000000000046")]
public interface TextFrametype TextFrame = interfacePublic Interface TextFrame- Attributes
Remarks
Use the TextFrame property to return the TextFrame object for a shape. The TextRange property returns a Range object that represents the range of text inside the specified text frame.
Note Some shapes don't support attached text (lines, freeforms, pictures, and OLE objects, for example). If you attempt to return or set properties that control text in a text frame for those objects, an error occurs.
Use the HasText property to determine whether the text frame contains text.
Text frames can be linked together so that the text flows from the text frame of one shape into the text frame of another shape. Use the Next and Previous properties to link text frames.
Use the ContainingRange property to return a Range object that represents the entire story that flows between linked text frames.
Properties
| Application |
Returns a Application object that represents the Microsoft Word application. |
| AutoSize |
Returns or sets an Integer that represents whether a text frame is sized automatically. |
| Column |
Gets the TextColumn2 object that represents the columns of the specified text frame. |
| ContainingRange |
Returns a Range object that represents the entire story in a series of shapes with linked text frames that the specified text frame belongs to. |
| Creator |
Returns a 32-bit integer that indicates the application in which the specified object was created. |
| HasText |
True if the specified shape has text associated with it. |
| HorizontalAnchor |
Gets or sets the horizontal alignment of text in a text frame. |
| MarginBottom |
Returns or sets the distance (in points) between the bottom of the text frame and the bottom of the inscribed rectangle of the shape that contains the text. |
| MarginLeft |
Returns or sets the distance (in points) between the left edge of the text frame and the left edge of the inscribed rectangle of the shape that contains the text. |
| MarginRight |
Returns or sets the distance (in points) between the right edge of the text frame and the right edge of the inscribed rectangle of the shape that contains the text. |
| MarginTop |
Returns or sets the distance (in points) between the top of the text frame and the top of the inscribed rectangle of the shape that contains the text. |
| Next |
Returns the next object in the collection. |
| NoTextRotation |
Gets or sets whether the text in the text frame should not rotate when the shape is rotated. |
| Orientation |
Returns or sets the orientation of the text inside the frame. |
| Overflowing |
True if the text inside the specified text frame doesn't all fit within the frame. |
| Parent |
Returns a Shape object representing the parent shape of the text frame. |
| PathFormat |
Gets or sets the path type for the specified text frame. |
| Previous |
Returns the previous object in the collection. |
| TextRange |
Returns a Range object that represents the text in the specified text frame. |
| ThreeD |
Gets a ThreeDFormat object that contains 3-D effect formatting properties for the specified text frame. |
| VerticalAnchor |
Returns or sets an MsoVerticalAnchor constant that represents the vertical alignment of the text within a shape. Read/write. |
| WarpFormat |
Gets or sets the warp format (how the text is warped) for the specified text frame. |
| WordWrap |
True if Microsoft Word wraps Latin text in the middle of a word in the specified paragraphs or text frames. |
Methods
| BreakForwardLink() |
Breaks the forward link for the specified text frame, if such a link exists. |
| DeleteText() |
Deletes the text from a text frame and all the associated properties of the text, including font attributes. |
| ValidLinkTarget(TextFrame) |
Determines whether the text frame of one shape can be linked to the text frame of another shape. |