PictureCollection

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

public class PictureCollection extends CollectionBase

Encapsulates a collection of Picture objects.

Example

         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
 
         //get PictureCollection
         PictureCollection pictures = workbook.getWorksheets().get(0).getPictures();
 
         //do your business
 
         //Save the excel file.
         workbook.save("result.xlsx");

Methods

Method	Description
add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, InputStream stream)	Adds a picture to the collection.
add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, String fileName)	Adds a picture to the collection.
add(int upperLeftRow, int upperLeftColumn, InputStream stream)	Adds a picture to the collection.
add(int upperLeftRow, int upperLeftColumn, InputStream stream, int widthScale, int heightScale)	Adds a picture to the collection.
add(int upperLeftRow, int upperLeftColumn, String fileName)	Adds a picture to the collection.
add(int upperLeftRow, int upperLeftColumn, String fileName, int widthScale, int heightScale)	Adds a picture to the collection.
add(Object o)	Adds an item to the CollectionBase instance.
clear()	Clear all pictures.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets the Picture element at the specified index.
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 shapes at the specific index
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, InputStream stream)

public int add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, InputStream stream)

Adds a picture to the collection.

Parameters:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
lowerRightRow	int	Lower right row index
lowerRightColumn	int	Lower right column index
stream	java.io.InputStream	Stream object which contains the image data.

Returns: int - Picture object index.

add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, String fileName)

public int add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, String fileName)

Adds a picture to the collection.

Example

         //add a picture
         pictures.add(1, 1, 5, 5, "image.jpg");

Parameters:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
lowerRightRow	int	Lower right row index
lowerRightColumn	int	Lower right column index
fileName	java.lang.String	Image filename.

Returns: int - Picture object index.

add(int upperLeftRow, int upperLeftColumn, InputStream stream)

public int add(int upperLeftRow, int upperLeftColumn, InputStream stream)

Adds a picture to the collection.

Parameters:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
stream	java.io.InputStream	Stream object which contains the image data.

Returns: int - Picture object index.

add(int upperLeftRow, int upperLeftColumn, InputStream stream, int widthScale, int heightScale)

public int add(int upperLeftRow, int upperLeftColumn, InputStream stream, int widthScale, int heightScale)

Adds a picture to the collection.

Parameters:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
stream	java.io.InputStream	Stream object which contains the image data.
widthScale	int	Scale of image width, a percentage.
heightScale	int	Scale of image height, a percentage.

Returns: int - Picture object index.

add(int upperLeftRow, int upperLeftColumn, String fileName)

public int add(int upperLeftRow, int upperLeftColumn, String fileName)

Adds a picture to the collection.

Example

         //add a picture
         pictures.add(1, 1, "image.jpg");

Parameters:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
fileName	java.lang.String	Image filename.

Returns: int - Picture object index.

add(int upperLeftRow, int upperLeftColumn, String fileName, int widthScale, int heightScale)

public int add(int upperLeftRow, int upperLeftColumn, String fileName, int widthScale, int heightScale)

Adds a picture to the collection.

Example

         //add a picture
         pictures.add(1, 1, "image.jpg", 50, 50);

Parameters:

Parameter	Type	Description
upperLeftRow	int	Upper left row index.
upperLeftColumn	int	Upper left column index.
fileName	java.lang.String	Image filename.
widthScale	int	Scale of image width, a percentage.
heightScale	int	Scale of image height, a percentage.

Returns: int - Picture 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 pictures.

Example

         //clear
         pictures.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 Picture get(int index)

Gets the Picture element at the specified index.

Example

         //get picture collection
         //PictureCollection pictures = workbook.Worksheets[0].Pictures;
         //add a picture
         int index = pictures.add(1, 1, "image.png");
         //get the picture
         Picture pic = pictures.get(index);

Parameters:

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

Returns: Picture - The element at the specified index.

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 shapes at the specific index

Example

         //add a picture
         int index2 = pictures.add(1, 1, "image.png");
         //delete
         pictures.removeAt(index2);

Parameters:

Parameter	Type	Description
index	int

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