TextBoxOptions (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.TextBoxOptions

public class TextBoxOptions
extends java.lang.Object

Represents the text options of the shape

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         int index = workbook.getWorksheets().get(0).getTextBoxes().add(0, 0, 350, 350);
         Shape shape = workbook.getWorksheets().get(0).getTextBoxes().get(index);
         shape.setText("This is test.");
 
         //do your business
 
         //Save the excel file.
         workbook.save("exmaple.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAllowTextToOverflow()` Whether allow text to overflow shape.
`double`	`getBottomMarginPt()` Returns the bottom margin in unit of Points
`double`	`getLeftMarginPt()` Gets the left margin in unit of Points.
`boolean`	`getResizeToFitText()` Indicates whether to resize the shape to fit the text
`double`	`getRightMarginPt()` Gets the right margin in unit of Points.
`int`	`getShapeTextDirection()` Gets the text display direction within a given text body.
`int`	`getShapeTextVerticalAlignment()` It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel.
`double`	`getTopMarginPt()` Gets the top margin in unit of Points.
`boolean`	`getWrapTextInShape()` Specifies text wrapping within a shape.
`void`	`setAllowTextToOverflow(boolean value)` Whether allow text to overflow shape.
`void`	`setBottomMarginPt(double value)` Returns the bottom margin in unit of Points
`void`	`setLeftMarginPt(double value)` Sets the left margin in unit of Points.
`void`	`setResizeToFitText(boolean value)` Indicates whether to resize the shape to fit the text
`void`	`setRightMarginPt(double value)` Sets the right margin in unit of Points.
`void`	`setShapeTextDirection(int value)` Sets the text display direction within a given text body.
`void`	`setShapeTextVerticalAlignment(int value)` It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel.
`void`	`setTopMarginPt(double value)` Sets the top margin in unit of Points.
`void`	`setWrapTextInShape(boolean value)` Specifies text wrapping within a shape.

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

- Method Detail
  - getShapeTextVerticalAlignment
```
public int getShapeTextVerticalAlignment()
```
    It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel.
    See ShapeTextVerticalAlignmentType.
    
    Example
```
 
         shape.getTextBoxOptions().setShapeTextVerticalAlignment(ShapeTextVerticalAlignmentType.LEFT);
 
```
  - setShapeTextVerticalAlignment
```
public void setShapeTextVerticalAlignment(int value)
```
    It corresponds to "Format Shape - Text Options - Text Box - Vertical Alignment" in Excel.
    See ShapeTextVerticalAlignmentType.
  - getResizeToFitText
```
public boolean getResizeToFitText()
```
    Indicates whether to resize the shape to fit the text
    Example
```
 
         shape.getTextBoxOptions().setResizeToFitText(true);
 
```
  - setResizeToFitText
```
public void setResizeToFitText(boolean value)
```
    Indicates whether to resize the shape to fit the text
  - getShapeTextDirection
```
public int getShapeTextDirection()
```
    Gets the text display direction within a given text body. It corresponds to "Format Shape - Text Options - Text Box - Text direction" in Excel
    See TextVerticalType.
    
    Example
```
 
         shape.getTextBoxOptions().setShapeTextDirection(TextVerticalType.VERTICAL);
 
```
  - setShapeTextDirection
```
public void setShapeTextDirection(int value)
```
    Sets the text display direction within a given text body. It corresponds to "Format Shape - Text Options - Text Box - Text direction" in Excel
    See TextVerticalType.
  - getLeftMarginPt
```
public double getLeftMarginPt()
```
    Gets the left margin in unit of Points.
    Example
```
 
         shape.getTextBoxOptions().setLeftMarginPt(0.2d);
 
```
  - setLeftMarginPt
```
public void setLeftMarginPt(double value)
```
    Sets the left margin in unit of Points.
  - getRightMarginPt
```
public double getRightMarginPt()
```
    Gets the right margin in unit of Points.
    Example
```
 
         shape.getTextBoxOptions().setRightMarginPt(0.2d);
 
```
  - setRightMarginPt
```
public void setRightMarginPt(double value)
```
    Sets the right margin in unit of Points.
  - getTopMarginPt
```
public double getTopMarginPt()
```
    Gets the top margin in unit of Points.
    Example
```
 
         shape.getTextBoxOptions().setTopMarginPt(0.2d);
 
```
  - setTopMarginPt
```
public void setTopMarginPt(double value)
```
    Sets the top margin in unit of Points.
  - getBottomMarginPt
```
public double getBottomMarginPt()
```
    Returns the bottom margin in unit of Points
    Example
```
 
         shape.getTextBoxOptions().setBottomMarginPt(0.2d);
 
```
  - setBottomMarginPt
```
public void setBottomMarginPt(double value)
```
    Returns the bottom margin in unit of Points
  - getAllowTextToOverflow
```
public boolean getAllowTextToOverflow()
```
    Whether allow text to overflow shape.
    Example
```
 
         shape.getTextBoxOptions().setAllowTextToOverflow(true);
 
```
  - setAllowTextToOverflow
```
public void setAllowTextToOverflow(boolean value)
```
    Whether allow text to overflow shape.
  - getWrapTextInShape
```
public boolean getWrapTextInShape()
```
    Specifies text wrapping within a shape. False - No wrapping will occur on text body. True - Wrapping will occur on text body.
    Example
```
 
         shape.getTextBoxOptions().setWrapTextInShape(true);
 
```
  - setWrapTextInShape
```
public void setWrapTextInShape(boolean value)
```
    Specifies text wrapping within a shape. False - No wrapping will occur on text body. True - Wrapping will occur on text body.

Class TextBoxOptions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getShapeTextVerticalAlignment

setShapeTextVerticalAlignment

getResizeToFitText

setResizeToFitText

getShapeTextDirection

setShapeTextDirection

getLeftMarginPt

setLeftMarginPt

getRightMarginPt

setRightMarginPt

getTopMarginPt

setTopMarginPt

getBottomMarginPt

setBottomMarginPt

getAllowTextToOverflow

setAllowTextToOverflow

getWrapTextInShape

setWrapTextInShape