TextBox (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.TextBox

```
public class TextBox
extends java.lang.Object
```
Defines attributes that specify how a text is displayed inside a shape.
Use the Shape.getTextBox() property to access text properties of a shape. You do not create instances of the TextBox class directly.

See Also:

Shape.getTextBox()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`breakForwardLink()` Breaks the link to the next TextBox.
`boolean`	`getFitShapeToText()` Determines whether Microsoft Word will grow the shape to fit text.
`double`	`getInternalMarginBottom()` Specifies the inner bottom margin in points for a shape.
`double`	`getInternalMarginLeft()` Specifies the inner left margin in points for a shape.
`double`	`getInternalMarginRight()` Specifies the inner right margin in points for a shape.
`double`	`getInternalMarginTop()` Specifies the inner top margin in points for a shape.
`int`	`getLayoutFlow()` Determines the flow of the text layout in a shape.
`TextBox`	`getNext()` Gets a TextBox that represents the next TextBox in a sequence of shapes.
`Shape`	`getParent()` Gets a parent shape for the TextBox.
`TextBox`	`getPrevious()` Returns a TextBox that represents the previous TextBox in a sequence of shapes.
`int`	`getTextBoxWrapMode()` Determines how text wraps inside a shape.
`int`	`getVerticalAnchor()` Specifies the vertical alignment of the text within a shape.
`boolean`	`isValidLinkTarget(TextBox target)` Determines whether this TextBox can be linked to the target Textbox.
`void`	`setFitShapeToText(boolean value)` Determines whether Microsoft Word will grow the shape to fit text.
`void`	`setInternalMarginBottom(double value)` Specifies the inner bottom margin in points for a shape.
`void`	`setInternalMarginLeft(double value)` Specifies the inner left margin in points for a shape.
`void`	`setInternalMarginRight(double value)` Specifies the inner right margin in points for a shape.
`void`	`setInternalMarginTop(double value)` Specifies the inner top margin in points for a shape.
`void`	`setLayoutFlow(int value)` Determines the flow of the text layout in a shape.
`void`	`setNext(TextBox value)` Sets a TextBox that represents the next TextBox in a sequence of shapes.
`void`	`setTextBoxWrapMode(int value)` Determines how text wraps inside a shape.
`void`	`setVerticalAnchor(int value)` Specifies the vertical alignment of the text within a shape.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInternalMarginLeft
```
public double getInternalMarginLeft()
```
    Specifies the inner left margin in points for a shape.
    The default value is 1/10 inch.
    
    Returns:
    
    The corresponding double value.
  - setInternalMarginLeft
```
public void setInternalMarginLeft(double value)
```
    Specifies the inner left margin in points for a shape.
    The default value is 1/10 inch.
    
    Parameters:
    
    value - The corresponding double value.
  - getInternalMarginRight
```
public double getInternalMarginRight()
```
    Specifies the inner right margin in points for a shape.
    The default value is 1/10 inch.
    
    Returns:
    
    The corresponding double value.
  - setInternalMarginRight
```
public void setInternalMarginRight(double value)
```
    Specifies the inner right margin in points for a shape.
    The default value is 1/10 inch.
    
    Parameters:
    
    value - The corresponding double value.
  - getInternalMarginTop
```
public double getInternalMarginTop()
```
    Specifies the inner top margin in points for a shape.
    The default value is 1/20 inch.
    
    Returns:
    
    The corresponding double value.
  - setInternalMarginTop
```
public void setInternalMarginTop(double value)
```
    Specifies the inner top margin in points for a shape.
    The default value is 1/20 inch.
    
    Parameters:
    
    value - The corresponding double value.
  - getInternalMarginBottom
```
public double getInternalMarginBottom()
```
    Specifies the inner bottom margin in points for a shape.
    The default value is 1/20 inch.
    
    Returns:
    
    The corresponding double value.
  - setInternalMarginBottom
```
public void setInternalMarginBottom(double value)
```
    Specifies the inner bottom margin in points for a shape.
    The default value is 1/20 inch.
    
    Parameters:
    
    value - The corresponding double value.
  - getFitShapeToText
```
public boolean getFitShapeToText()
```
    Determines whether Microsoft Word will grow the shape to fit text.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setFitShapeToText
```
public void setFitShapeToText(boolean value)
```
    Determines whether Microsoft Word will grow the shape to fit text.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getLayoutFlow
```
public int getLayoutFlow()
```
    Determines the flow of the text layout in a shape.
    The default value is LayoutFlow.HORIZONTAL.
    
    Returns:
    
    The corresponding int value. The returned value is one of LayoutFlow constants.
  - setLayoutFlow
```
public void setLayoutFlow(int value)
```
    Determines the flow of the text layout in a shape.
    The default value is LayoutFlow.HORIZONTAL.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of LayoutFlow constants.
  - getTextBoxWrapMode
```
public int getTextBoxWrapMode()
```
    Determines how text wraps inside a shape.
    The default value is TextBoxWrapMode.SQUARE.
    
    Returns:
    
    The corresponding int value. The returned value is one of TextBoxWrapMode constants.
  - setTextBoxWrapMode
```
public void setTextBoxWrapMode(int value)
```
    Determines how text wraps inside a shape.
    The default value is TextBoxWrapMode.SQUARE.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of TextBoxWrapMode constants.
  - getVerticalAnchor
```
public int getVerticalAnchor()
```
    Specifies the vertical alignment of the text within a shape.
    The default value is TextBoxAnchor.TOP.
    
    Returns:
    
    The corresponding int value. The returned value is one of TextBoxAnchor constants.
  - setVerticalAnchor
```
public void setVerticalAnchor(int value)
```
    Specifies the vertical alignment of the text within a shape.
    The default value is TextBoxAnchor.TOP.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of TextBoxAnchor constants.
  - isValidLinkTarget
```
public boolean isValidLinkTarget(TextBox target)
```
    Determines whether this TextBox can be linked to the target Textbox.
  - getNext
```
public TextBox getNext()
```
    Gets a TextBox that represents the next TextBox in a sequence of shapes.
    
    Returns:
    
    A TextBox that represents the next TextBox in a sequence of shapes.
  - setNext
```
public void setNext(TextBox value)
```
    Sets a TextBox that represents the next TextBox in a sequence of shapes.
    
    Parameters:
    
    value - A TextBox that represents the next TextBox in a sequence of shapes.
  - getPrevious
```
public TextBox getPrevious()
```
    Returns a TextBox that represents the previous TextBox in a sequence of shapes.
    
    Returns:
    
    A TextBox that represents the previous TextBox in a sequence of shapes.
  - breakForwardLink
```
public void breakForwardLink()
```
    Breaks the link to the next TextBox. BreakForwardLink() doesn't break all other links in the current sequence of shapes. For example: 1-2-3-4 sequence and BreakForwardLink at the 2-nd textbox will create two sequences 1-2, 3-4.
  - getParent
```
public Shape getParent()
```
    Gets a parent shape for the TextBox.
    
    Returns:
    
    A parent shape for the TextBox.

Class TextBox

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInternalMarginLeft

setInternalMarginLeft

getInternalMarginRight

setInternalMarginRight

getInternalMarginTop

setInternalMarginTop

getInternalMarginBottom

setInternalMarginBottom

getFitShapeToText

setFitShapeToText

getLayoutFlow

setLayoutFlow

getTextBoxWrapMode

setTextBoxWrapMode

getVerticalAnchor

setVerticalAnchor

isValidLinkTarget

getNext

setNext

getPrevious

breakForwardLink

getParent