Picture (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.Shape
- - com.aspose.cells.Picture

public class Picture
extends Shape

Encapsulates the object that represents a single picture in a spreadsheet.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //Adding a new worksheet to the Workbook object
         int sheetIndex = workbook.getWorksheets().add();
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
         //Adding a picture at the location of a cell whose row and column indices
         //are 5 in the worksheet. It is "F6" cell
         worksheet.getPictures().add(5, 5, "image.gif");
         //Saving the Excel file
         workbook.save("book1.xls", SaveFormat.EXCEL_97_TO_2003);

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`copy(Picture source, CopyOptions options)` Copy the picture.
`Color`	`getBorderLineColor()` Represents the `Color` of the border line of a picture.
`double`	`getBorderWeight()` Gets the weight of the border line of a picture in units of pt.
`byte[]`	`getData()` Gets the data of the picture.
`boolean`	`getDisplayAsIcon()` True if the specified object is displayed as an icon and the image will not be auto changed.
`java.lang.String`	`getFormula()` Gets the data of the formula.
`int`	`getImageType()` Gets the image format of the picture.
`int`	`getOriginalHeight()` Gets the original height of the picture.
`double`	`getOriginalHeightCM()` Gets the original height of picture, in unit of centimeters.
`double`	`getOriginalHeightInch()` Gets the original height of picture, in unit of inches.
`int`	`getOriginalWidth()` Gets the original width of the picture.
`double`	`getOriginalWidthCM()` Gets the original width of picture, in unit of centimeters.
`double`	`getOriginalWidthInch()` Gets the original width of picture, in unit of inches.
`SignatureLine`	`getSignatureLine()` Gets the signature line
`java.lang.String`	`getSourceFullName()` Gets the path and name of the source file for the linked image.
`boolean`	`isAutoSize()` True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content when the ole object is activated.
`boolean`	`isDynamicDataExchange()` Gets whether dynamic data exchange
`boolean`	`isLink()` Returns true if the picture is linked to a file.
`boolean`	`isSameSetting(java.lang.Object obj)` Returns whether the shape is same.
`void`	`move(int upperLeftRow, int upperLeftColumn)` Moves the picture to a specified location.
`void`	`placeInCell()` Place this picture in the cell
`void`	`setAutoSize(boolean value)` True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content when the ole object is activated.
`void`	`setBorderLineColor(Color value)` Represents the `Color` of the border line of a picture.
`void`	`setBorderWeight(double value)` Sets the weight of the border line of a picture in units of pt.
`void`	`setData(byte[] value)` Gets the data of the picture.
`void`	`setDisplayAsIcon(boolean value)` True if the specified object is displayed as an icon and the image will not be auto changed.
`void`	`setDynamicDataExchange(boolean value)` Sets whether dynamic data exchange
`void`	`setFormula(java.lang.String value)` Sets the data of the formula.
`void`	`setLink(boolean value)` Returns true if the picture is linked to a file.
`void`	`setSignatureLine(SignatureLine value)` Sets the signature line
`void`	`setSourceFullName(java.lang.String value)` Sets the path and name of the source file for the linked image.

Methods inherited from class com.aspose.cells.Shape
addHyperlink, alignTopRightCorner, calculateTextSize, characters, fitToTextSize, formatCharacters, getActiveXControl, getActualBox, getActualLowerRightRow, getAlternativeText, getAnchorType, getAutoShapeType, getBottom, getCharacters, getConnectionPoints, getControlData, getCreateId, getFill, getFillFormat, getFont, getFormatPicture, getGeometry, getGlow, getGroup, getHeight, getHeightCM, getHeightInch, getHeightInShape, getHeightPt, getHeightScale, getHtmlText, getHyperlink, getId, getInputRange, getInputRange, getLeft, getLeftCM, getLeftInch, getLeftInShape, getLeftToCorner, getLine, getLineFormat, getLinkedCell, getLinkedCell, getLockedProperty, getLowerDeltaX, getLowerDeltaY, getLowerRightColumn, getLowerRightRow, getMacroName, getMsoDrawingType, getName, getPaths, getPlacement, getReflection, getRelativeToOriginalPictureSize, getResultOfSmartArt, getRichFormattings, getRight, getRotationAngle, getShadowEffect, getSoftEdges, getSpid, getSpt, getText, getTextBody, getTextBoxOptions, getTextDirection, getTextEffect, getTextHorizontalAlignment, getTextHorizontalOverflow, getTextOptions, getTextOrientationType, getTextShapeType, getTextVerticalAlignment, getTextVerticalOverflow, getThreeDFormat, getTitle, getTop, getTopCM, getTopInch, getTopInShape, getTopToCorner, getType, getUpperDeltaX, getUpperDeltaY, getUpperLeftColumn, getUpperLeftRow, getWidth, getWidthCM, getWidthInch, getWidthInShape, getWidthPt, getWidthScale, getWorksheet, getX, getY, getZOrderPosition, hasLine, isAspectRatioLocked, isDecorative, isEquation, isFilled, isFlippedHorizontally, isFlippedVertically, isGroup, isHidden, isInGroup, isLockAspectRatio, isLocked, isPrintable, isRichText, isSmartArt, isTextWrapped, isWordArt, moveToRange, removeActiveXControl, removeHyperlink, setAlternativeText, setAnchorType, setAspectRatioLocked, setAutoShapeType, setBottom, setCreateId, setDecorative, setFilled, setFlippedHorizontally, setFlippedVertically, setFont, setHasLine, setHeight, setHeightCM, setHeightInch, setHeightInShape, setHeightPt, setHeightScale, setHidden, setHtmlText, setInputRange, setInputRange, setLeft, setLeftCM, setLeftInch, setLeftInShape, setLeftToCorner, setLinkedCell, setLinkedCell, setLockAspectRatio, setLocked, setLockedProperty, setLowerDeltaX, setLowerDeltaY, setLowerRightColumn, setLowerRightRow, setMacroName, setName, setPlacement, setPrintable, setRelativeToOriginalPictureSize, setRight, setRotationAngle, setSoftEdges, setText, setTextDirection, setTextHorizontalAlignment, setTextHorizontalOverflow, setTextOptions, setTextOrientationType, setTextShapeType, setTextVerticalAlignment, setTextVerticalOverflow, setTextWrapped, setTitle, setTop, setTopCM, setTopInch, setTopInShape, setTopToCorner, setUpperDeltaX, setUpperDeltaY, setUpperLeftColumn, setUpperLeftRow, setWidth, setWidthCM, setWidthInch, setWidthInShape, setWidthPt, setWidthScale, setX, setY, setZOrderPosition, toFrontOrBack, toImage, toImage, toImage, updateSelectedValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

copy

public void copy(Picture source,
        CopyOptions options)

Copy the picture.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //insert first picture
         int imgIndex1 = worksheet.getPictures().add(1, 1, "1.png");
         //Get the inserted picture object
         Picture pic1 = worksheet.getPictures().get(imgIndex1);
         //insert second picture
         int imgIndex2 = worksheet.getPictures().add(1, 9, "2.jpeg");
         //Get the inserted picture object
         Picture pic2 = worksheet.getPictures().get(imgIndex2);
         //Copy picture 1 to picture 2.You'll get two picture 1 objects that are superimposed on top of each other.
         CopyOptions opt = new CopyOptions();
         pic2.copy(pic1, opt);
         //Save the excel file.
         workbook.save("result.xlsx");

Parameters:: source - The source picture.; options - The copy options.

move

public void move(int upperLeftRow,
        int upperLeftColumn)

Moves the picture to a specified location.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Set the new location of the picture
         pic.move(2, 4);
         //Save the excel file.
         workbook.save("result.xlsx");

Parameters:: upperLeftRow - Upper left row index.; upperLeftColumn - Upper left column index.

placeInCell
```
public void placeInCell()
```
Place this picture in the cell

getOriginalHeight

public int getOriginalHeight()

Gets the original height of the picture.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Gets the original height of the picture.
         int picHeight = pic.getOriginalHeight();
         //Save the excel file.
         workbook.save("result.xlsx");

getOriginalWidth

public int getOriginalWidth()

Gets the original width of the picture.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Gets the original width of the picture.
         int picWidth = pic.getOriginalWidth();
         //Save the excel file.
         workbook.save("result.xlsx");

getBorderLineColor

public Color getBorderLineColor()

Represents the Color of the border line of a picture.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Set the border color of the picture
         pic.setBorderLineColor(Color.getRed());
         //Save the excel file.
         workbook.save("result.xlsx");

setBorderLineColor
```
public void setBorderLineColor(Color value)
```
Represents the Color of the border line of a picture.

getBorderWeight

public double getBorderWeight()

Gets the weight of the border line of a picture in units of pt.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Set the border color of the picture
         pic.setBorderLineColor(Color.getRed());
         //Set the border width of the picture
         pic.setBorderWeight(3);
         //Save the excel file.
         workbook.save("result.xlsx");

setBorderWeight
```
public void setBorderWeight(double value)
```
Sets the weight of the border line of a picture in units of pt.

getData

public byte[] getData()

Gets the data of the picture.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //insert first picture
         int imgIndex1 = worksheet.getPictures().add(1, 1, "example1.png");
         //Get the inserted picture object
         Picture pic1 = worksheet.getPictures().get(imgIndex1);
         //insert second picture
         int imgIndex2 = worksheet.getPictures().add(1, 9, "example2.jpeg");
         //Get the inserted picture object
         Picture pic2 = worksheet.getPictures().get(imgIndex2);
         //Assign the byte data of the first image to the second image
         pic2.setData(pic1.getData());
         //Save the excel file.
         workbook.save("result.xlsx");

setData
```
public void setData(byte[] value)
```
Gets the data of the picture.

getSourceFullName
```
public java.lang.String getSourceFullName()
```
Gets the path and name of the source file for the linked image.
Remarks
The default value is an empty string. If SourceFullName is not an empty string, the image is linked. If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.

setSourceFullName
```
public void setSourceFullName(java.lang.String value)
```
Sets the path and name of the source file for the linked image.
Remarks
The default value is an empty string. If SourceFullName is not an empty string, the image is linked. If SourceFullName is not an empty string, but Data is null, then the image is linked and not stored in the file.

getFormula
```
public java.lang.String getFormula()
```
Gets the data of the formula.

setFormula

public void setFormula(java.lang.String value)

Sets the data of the formula.

isAutoSize
```
public boolean isAutoSize()
```
True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content when the ole object is activated.

setAutoSize
```
public void setAutoSize(boolean value)
```
True indicates that the size of the ole object will be auto changed as the size of snapshot of the embedded content when the ole object is activated.

isLink
```
public boolean isLink()
```
Returns true if the picture is linked to a file.

setLink
```
public void setLink(boolean value)
```
Returns true if the picture is linked to a file.

isDynamicDataExchange
```
public boolean isDynamicDataExchange()
```
Gets whether dynamic data exchange

setDynamicDataExchange
```
public void setDynamicDataExchange(boolean value)
```
Sets whether dynamic data exchange

getDisplayAsIcon
```
public boolean getDisplayAsIcon()
```
True if the specified object is displayed as an icon and the image will not be auto changed.

setDisplayAsIcon
```
public void setDisplayAsIcon(boolean value)
```
True if the specified object is displayed as an icon and the image will not be auto changed.

getImageType

public int getImageType()

Gets the image format of the picture.

See ImageType.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //insert first picture
         int imgIndex1 = worksheet.getPictures().add(1, 1, "1.png");
         //Get the inserted picture object
         Picture pic1 = worksheet.getPictures().get(imgIndex1);
         if(pic1.getImageType() == com.aspose.cells.ImageType.PNG)
         {
             //The picture's type is png.";
         }
         //insert second picture
         int imgIndex2 = worksheet.getPictures().add(1, 9, "2.jpeg");
         //Get the inserted picture object
         Picture pic2 = worksheet.getPictures().get(imgIndex2);
         if(pic2.getImageType() == com.aspose.cells.ImageType.JPEG)
         {
             //The picture's type is jpg.";
         }

getOriginalHeightCM

public double getOriginalHeightCM()

Gets the original height of picture, in unit of centimeters.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Gets the original height of the picture.
         double picHeightCM = pic.getOriginalHeightCM();
         //Save the excel file.
         workbook.save("result.xlsx");

getOriginalWidthCM

public double getOriginalWidthCM()

Gets the original width of picture, in unit of centimeters.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Gets the original width of the picture.
         double picWidthCM = pic.getOriginalWidthCM();
         //Save the excel file.
         workbook.save("result.xlsx");

getOriginalHeightInch

public double getOriginalHeightInch()

Gets the original height of picture, in unit of inches.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Gets the original height of the picture.
         double picHeightInch = pic.getOriginalHeightInch();
         //Save the excel file.
         workbook.save("result.xlsx");

getOriginalWidthInch

public double getOriginalWidthInch()

Gets the original width of picture, in unit of inches.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, "example.jpeg");
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         //Gets the original width of the picture.
         double picWidthInch = pic.getOriginalWidthInch();
         //Save the excel file.
         workbook.save("result.xlsx");

getSignatureLine

public SignatureLine getSignatureLine()

Gets the signature line

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //Adding a picture at the location of a cell whose row and column indices are 1 in the worksheet. It is "B2" cell
         int imgIndex = worksheet.getPictures().add(1, 1, (String)null);
         //Get the inserted picture object
         Picture pic = worksheet.getPictures().get(imgIndex);
         // Create signature line object
         SignatureLine s = new SignatureLine();
         s.setSigner("Simon");
         s.setTitle("Development");
         s.setEmail("simon@aspose.com");
         // Assign the signature line object to Picture.
         pic.setSignatureLine(s);
         //Save the excel file.
         workbook.save("result.xlsx");

setSignatureLine

public void setSignatureLine(SignatureLine value)

Sets the signature line

isSameSetting

public boolean isSameSetting(java.lang.Object obj)

Returns whether the shape is same.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         Worksheet worksheet = workbook.getWorksheets().get(0);
         //insert first picture
         int imgIndex1 = worksheet.getPictures().add(1, 1, "1.png");
         //Get the inserted picture object
         Picture pic1 = worksheet.getPictures().get(imgIndex1);
         //insert second picture
         int imgIndex2 = worksheet.getPictures().add(1, 9, "2.jpeg");
         //Get the inserted picture object
         Picture pic2 = worksheet.getPictures().get(imgIndex2);
         if(pic1.isSameSetting(pic1))
         {
             //two image objects are the same.
         }
 
         if(!pic1.isSameSetting(pic2))
         {
             //two image objects are not the same.
         }

Overrides:: isSameSetting in class Shape
Parameters:: obj -
Returns:

Class Picture

Method Summary

Methods inherited from class com.aspose.cells.Shape

Methods inherited from class java.lang.Object

Method Detail

copy

move

placeInCell

getOriginalHeight

getOriginalWidth

getBorderLineColor

setBorderLineColor

getBorderWeight

setBorderWeight

getData

setData

getSourceFullName

setSourceFullName

getFormula

setFormula

isAutoSize

setAutoSize

isLink

setLink

isDynamicDataExchange

setDynamicDataExchange

getDisplayAsIcon

setDisplayAsIcon

getImageType

getOriginalHeightCM

getOriginalWidthCM

getOriginalHeightInch

getOriginalWidthInch

getSignatureLine

setSignatureLine

isSameSetting