TextBoxCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

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

Methods

Method	Description
add(int upperLeftRow, int upperLeftColumn, int height, int width)	Adds a textbox to the collection.
add(Object o)	Adds an item to the CollectionBase instance.
clear()	Clear all text boxes.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets the TextBox element at the specified index.
get(String name)	Gets the TextBox element by the name.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeAt(int index)	Remove a text box from the file.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

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

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:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
height	int	Height of textbox, in unit of pixel.
width	int	Width of textbox, in unit of pixel.

Returns: int - TextBox object index.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

clear()

public void clear()

Clear all text boxes.

Example

         //clear all textbox
         textBoxCollection.clear();

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int index)

public TextBox get(int index)

Gets the TextBox element at the specified index.

Example

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

Parameters:

Parameter	Type	Description
index	int	The zero based index of the element.

Returns: TextBox - The element at the specified index.

get(String name)

public TextBox get(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:

Parameter	Type	Description
name	java.lang.String	The name of the text box.

Returns: TextBox -

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeAt(int index)

public void removeAt(int index)

Remove a text box from the file.

Example

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

Parameters:

Parameter	Type	Description
index	int	The text box index.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int