TextBox
Overview
TextBox is a class in Aspose.Words FOSS for Java.
Defines attributes that specify how a text is displayed inside a shape.
Edition status of its 36 listed members (a property and its accessor methods are listed separately, overloads once): 36 not yet exercised by a verified example.
This class declares 24 methods for TextBox objects in Java programs.
Available methods include: breakForwardLink, getFitShapeToText, getInternalMarginBottom, getInternalMarginLeft, getInternalMarginRight, getInternalMarginTop, getLayoutFlow, getNext, getNoTextRotation, getParent, getPrevious, getTextBoxWrapMode, and 12 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: fitShapeToText, internalMarginBottom, internalMarginLeft, internalMarginRight, internalMarginTop, layoutFlow, and 6 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
internalMarginLeft | double | Read/Write | Specifies the inner left margin in points for a shape. |
internalMarginRight | double | Read/Write | Specifies the inner right margin in points for a shape. |
internalMarginTop | double | Read/Write | Specifies the inner top margin in points for a shape. |
internalMarginBottom | double | Read/Write | Specifies the inner bottom margin in points for a shape. |
fitShapeToText | boolean | Read/Write | Determines whether Microsoft Word will grow the shape to fit text. |
layoutFlow | int | Read/Write | Determines the flow of the text layout in a shape. |
textBoxWrapMode | int | Read/Write | Determines how text wraps inside a shape. |
noTextRotation | boolean | Read/Write | Gets or sets a boolean value indicating either text of the TextBox should not rotate when the shape is rotated. |
verticalAnchor | int | Read/Write | Specifies the vertical alignment of the text within a shape. |
next | TextBox | Read/Write | Returns or sets a TextBox that represents the next TextBox in a sequence of shapes. |
previous | TextBox | Read | Returns a TextBox that represents the previous TextBox in a sequence of shapes. |
parent | Shape | Read | Gets a parent shape for the TextBox. |
Methods
| Signature | Description |
|---|---|
getInternalMarginLeft() → double | Specifies the inner left margin in points for a shape. |
setInternalMarginLeft(value: double) | Sets the internal margin left value. |
getInternalMarginRight() → double | Specifies the inner right margin in points for a shape. |
setInternalMarginRight(value: double) | Sets the internal margin right value. |
getInternalMarginTop() → double | Specifies the inner top margin in points for a shape. |
setInternalMarginTop(value: double) | Sets the internal margin top value. |
getInternalMarginBottom() → double | Specifies the inner bottom margin in points for a shape. |
setInternalMarginBottom(value: double) | Sets the internal margin bottom value. |
getFitShapeToText() → boolean | Determines whether Microsoft Word will grow the shape to fit text. |
setFitShapeToText(value: boolean) | Sets the fit shape to text value. |
getLayoutFlow() → int | Determines the flow of the text layout in a shape. |
setLayoutFlow(value: int) | Sets the layout flow value. |
getTextBoxWrapMode() → int | Determines how text wraps inside a shape. |
setTextBoxWrapMode(value: int) | Sets the text box wrap mode value. |
getNoTextRotation() → boolean | Gets or sets a boolean value indicating either text of the TextBox should not rotate when the shape is rotated. |
setNoTextRotation(value: boolean) | Sets the no text rotation value. |
getVerticalAnchor() → int | Specifies the vertical alignment of the text within a shape. |
setVerticalAnchor(value: int) | Sets the vertical anchor value. |
isValidLinkTarget(target: TextBox) → boolean | Determines whether this TextBox can be linked to the target TextBox. |
getNext() → TextBox | Returns or sets a TextBox that represents the next TextBox in a sequence of shapes. |
setNext(value: TextBox) | Sets the next value. |
getPrevious() → TextBox | Returns a TextBox that represents the previous TextBox in a sequence of shapes. |
breakForwardLink() | Breaks the link to the next TextBox. |
getParent() → Shape | Gets a parent shape for the TextBox. |