com.aspose.cells

Class PictureCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.PictureCollection

All Implemented Interfaces:

java.lang.Iterable

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

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream) Adds a picture to the collection.
int	add(int upperLeftRow, int upperLeftColumn, java.io.InputStream stream, int widthScale, int heightScale) Adds a picture to the collection.
int	add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, java.io.InputStream stream) Adds a picture to the collection.
int	add(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn, java.lang.String fileName) Adds a picture to the collection.
int	add(int upperLeftRow, int upperLeftColumn, java.lang.String fileName) Adds a picture to the collection.
int	add(int upperLeftRow, int upperLeftColumn, java.lang.String fileName, int widthScale, int heightScale) Adds a picture to the collection.
int	camera(int row, int column, java.lang.String range) Takes a photo of the range.
void	clear() Clear all pictures.
Picture	get(int index) Gets the Picture element at the specified index.
void	removeAt(int index) Remove shapes at the specific index

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

camera

public int camera(int row,
         int column,
         java.lang.String range)

Takes a photo of the range.

Parameters:

row - The row index of this picture.

column - The column index of this picture.

range - The area that requires photography

Returns:

add

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.

add

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

Adds a picture to the collection.

Example

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

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.

add

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

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.

add

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

Adds a picture to the collection.

Example

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

Parameters:

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

fileName - Image filename.

Returns:

Picture object index.

add

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

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.

add

public int add(int upperLeftRow,
      int upperLeftColumn,
      java.lang.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:

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.

get

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

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

clear

public void clear()

Clear all pictures.

Example

 
         //clear
         pictures.clear();
 

Overrides:

clear in class CollectionBase

removeAt

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

Overrides:

removeAt in class CollectionBase

Parameters:

index - The zero-based index of the item to remove.