com.aspose.cells

Class TextBoxCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.TextBoxCollection

All Implemented Interfaces:

java.lang.Iterable

public class TextBoxCollection
extends CollectionBase

Encapsulates a collection of TextBox objects.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //get collection object
         TextBoxCollection textBoxCollection = workbook.getWorksheets().get(0).getTextBoxes();
         //add a textbox
         textBoxCollection.add(1, 1, 50, 100);
         for(TextBox tbox : (Iterable<TextBox>) textBoxCollection)
         {
             //do what you want
         }
 
         //do your business
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int upperLeftRow, int upperLeftColumn, int height, int width) Adds a textbox to the collection.
void	clear() Clear all text boxes.
TextBox	get(int index) Gets the TextBox element at the specified index.
TextBox	get(java.lang.String name) Gets the TextBox element by the name.
void	removeAt(int index) Remove a text box from the file.

Methods inherited from class com.aspose.cells.CollectionBase

add, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public TextBox get(int index)

Gets the TextBox element at the specified index.

Example

 
         int index = textBoxCollection.getCount() - 1;
         TextBox txb = textBoxCollection.get(index);
 

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

get

public TextBox get(java.lang.String name)

Gets the TextBox element by the name.

Example

 
         String txtboxName = "textbox 1"; 
         TextBox txb2 = textBoxCollection.get(txtboxName);
         if(txb2 != null)
         {
             //do what you want
         }
 

Parameters:

name - The name of the text box.

Returns:

add

public int add(int upperLeftRow,
      int upperLeftColumn,
      int height,
      int width)

Adds a textbox to the collection.

Example

 
         //add a TextBox
         int index2 = textBoxCollection.add(1, 1, 50, 100);
 

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

height - Height of textbox, in unit of pixel.

width - Width of textbox, in unit of pixel.

Returns:

TextBox object index.

removeAt

public void removeAt(int index)

Remove a text box from the file.

Example

 
         int index3 = textBoxCollection.getCount() - 1;
         textBoxCollection.removeAt(index3);
 

Overrides:

removeAt in class CollectionBase

Parameters:

index - The text box index.

clear

public void clear()

Clear all text boxes.

Example

 
         //clear all textbox
         textBoxCollection.clear();
 

Overrides:

clear in class CollectionBase