com.aspose.cells
Class PictureCollection

java.lang.Object
  CollectionBase
      com.aspose.cells.PictureCollection

All Implemented Interfaces:

java.lang.Iterable

public class PictureCollection 
extends CollectionBase

//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");

public int getCount()

public Picture get(int index)

Gets the Picture element at the specified index.

Parameters:

index - The zero based index of the element.

Returns:

The 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);

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

Adds a picture to the collection.

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

lowerRightRow - Lower right row index

lowerRightColumn - Lower right column index

stream - Stream object which contains the image data.

Returns:

Picture object index.

public int add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, java.lang.String fileName)
       throws java.lang.Exception

Adds a picture to the collection.

///

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

lowerRightRow - Lower right row index

lowerRightColumn - Lower right column index

fileName - Image filename.

Returns:

Picture object index.

Example:

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

public int add(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream)
       throws java.lang.Exception

Adds a picture to the collection.

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

stream - Stream object which contains the image data.

Returns:

Picture object index.

public int add(int upperLeftRow, int upperLeftColumn, java.lang.String fileName)
       throws java.lang.Exception

Adds a picture to the collection.

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

fileName - Image filename.

Returns:

Picture object index.

Example:

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

public int add(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream, int widthScale, int heightScale)
       throws java.lang.Exception

Adds a picture to the collection.

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

stream - Stream object which contains the image data.

widthScale - Scale of image width, a percentage.

heightScale - Scale of image height, a percentage.

Returns:

Picture object index.

public int add(int upperLeftRow, int upperLeftColumn, java.lang.String fileName, int widthScale, int heightScale)
       throws java.lang.Exception

Adds a picture to the collection.

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

fileName - Image filename.

widthScale - Scale of image width, a percentage.

heightScale - Scale of image height, a percentage.

Returns:

Picture object index.

Example:

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

public void clear()

Clear all pictures.

Example:

//clear
pictures.clear();

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);

public java.util.Iterator iterator()

public boolean contains(java.lang.Object value)

Reserved for internal use.

public int add(java.lang.Object value)

Reserved for internal use.

public int indexOf(java.lang.Object value)

Reserved for internal use.