Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class TextBoxes

java.lang.Object
  extended by com.aspose.cells.TextBoxes

public class TextBoxes
extends java.lang.Object

Encapsulates a collection of TextBox objects.


Method Summary
 int add(int row, int column, int width, int height)
          Deprecated. replaced by Shapes.addTextBox(int, int, int, int, int, int)
 int add(int row, int column, int left, int top, int width, int height)
          Deprecated. replaced by Shapes.addTextBox(int, int, int, int, int, int)
 int addInChart(int left, int top, int width, int height)
          Deprecated. replaced by Shapes.addTextBoxInChart(int, int, int, int)
 TextBox get(int index)
          Gets text box object by index.
 int size()
          Gets number of text boxs in the worksheet.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

add

public int add(int row,
               int column,
               int width,
               int height)
Deprecated. replaced by Shapes.addTextBox(int, int, int, int, int, int)

Adds a text box to the collection.

Parameters:
row - row index.
column - column index.
width - height of textbox, in unit of pixel.
height - width of textbox, in unit of pixel.
Returns:
TextBox Object index.
Throws:
java.lang.IllegalArgumentException - if row or column index is out of range.
CellsException - if the textbox collection has been removed from the worksheet.
java.lang.UnsupportedOperationException - if TextBoxes object belongs to Chart
See Also:
add(int, int, int, int, int, int)

add

public int add(int row,
               int column,
               int left,
               int top,
               int width,
               int height)
Deprecated. replaced by Shapes.addTextBox(int, int, int, int, int, int)

Adds a text box to the text boxes collection.

Parameters:
row - row index.
column - column index.
left - the horizontal offset of textbox from the left corner of the chart, in unit of pixel.
top - the vertical offset of textbox from the left corner of the chart, in unit of pixel.
width - height of textbox, in unit of pixel.
height - width of textbox, in unit of pixel.
Returns:
TextBox Object index.
Throws:
java.lang.IllegalArgumentException - if row or column index is out of range.
CellsException - if the textbox collection has been removed from the worksheet.
java.lang.UnsupportedOperationException - if TextBoxes object belongs to Chart

addInChart

public int addInChart(int left,
                      int top,
                      int width,
                      int height)
Deprecated. replaced by Shapes.addTextBoxInChart(int, int, int, int)

Adds a text box to the text boxes collection.

Parameters:
left - the horizontal offset of textbox from the left corner of the chart, in units of 1/4000 of the chart area.
top - the vertical offset of textbox from the left corner of the chart, in units of 1/4000 of the chart area.
width - height of textbox, in units of 1/4000 of the chart area.
height - width of textbox, in units of 1/4000 of the chart area.
Returns:
TextBox Object index.
Throws:
CellsException - if the textbox collection has been removed from the worksheet.
java.lang.UnsupportedOperationException - if TextBoxes object doesn't belong to Chart

get

public TextBox get(int index)
Gets text box object by index.

Parameters:
index - text box object index.
Returns:
text box object.
Throws:
java.lang.IllegalArgumentException - if index is out of range.
CellsException - if the text box collection has been removed from the worksheet.

size

public int size()
Gets number of text boxs in the worksheet.

Returns:
number of text boxs.
Throws:
CellsException - if the text box collection has been removed from the worksheet.