public class GridPicture
extends java.lang.Object
| Modifier and Type | Method and Description |
|---|---|
GridHyperlink |
addHyperlink(java.lang.String address)
Adds a hyperlink to the shape.
|
void |
alignTopRightCorner(int topRow,
int rightColumn)
Moves the picture to the top-right corner.
|
java.lang.String |
getAlternativeText()
Returns or sets the descriptive (alternative) text string of the
GridShape object. |
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.
|
int |
getBottom()
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
|
byte[] |
getData()
Gets the data of the picture.
|
int |
getHeight()
Represents the height of shape, in unit of pixel.
|
double |
getHeightCM()
Represents the height of the shape, in unit of inches.
|
double |
getHeightInch()
Represents the height of the shape, in unit of inches.
|
double |
getHeightPt()
Represents the height of the shape, in unit of points.
|
int |
getHeightScale()
Gets the height scale,in unit of percent of the original picture height.
|
java.lang.String |
getHtmlText()
Gets the html string which contains data and some formattings in this textbox.
|
GridHyperlink |
getHyperlink()
Gets the hyperlink of the shape.
|
java.lang.String |
getID()
Gets /Sets the ID of the picture.
|
int |
getImageFormat()
Gets the image format of the picture.
|
int |
getLeft()
Represents the horizontal offset of shape from its left column, in unit of pixels.
|
double |
getLeftCM()
Represents the horizontal offset of shape from its left column, in unit of centimeters.
|
double |
getLeftInch()
Represents the horizontal offset of shape from its left column, in unit of inches.
|
int |
getLeftToCorner()
Represents the horizontal offset of shape from worksheet left board, in unit of pixels.
|
java.lang.String |
getLinkedCell()
Gets the worksheet range linked to the control's value.
|
int |
getLowerDeltaX()
Gets the shape's horizontal offset from its lower right corner column.
|
int |
getLowerDeltaY()
Gets the shape's vertical offset from its lower right corner row.
|
int |
getLowerRightColumn()
Represents lower right corner column index.
|
int |
getLowerRightRow()
Represents lower right corner row index.
|
java.lang.String |
getName()
Gets the name of the shape.
|
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.
|
boolean |
getRelativeToOriginalPictureSize()
Indicates whether shape is relative to original picture size.
|
int |
getRight()
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
|
double |
getRotationAngle()
Gets the rotation of the shape.
|
java.lang.String |
getSourceFullName()
Gets the path and name of the source file for the linked image.
|
java.lang.String |
getText()
Represents the string in this TextBox object.
|
java.lang.String |
getTitle()
Specifies the title (caption) of the current shape object.
|
int |
getTop()
Represents the vertical offset of shape from its top row, in unit of pixels.
|
double |
getTopCM()
Represents the vertical offset of shape from its top row, in unit of centimeters.
|
double |
getTopInch()
Represents the vertical offset of shape from its top row, in unit of inches.
|
int |
getTopToCorner()
Represents the vertical offset of shape from worksheet top board, in unit of pixels.
|
int |
getUpperDeltaX()
Gets the shape's horizontal offset from its upper left corner column.
|
int |
getUpperDeltaY()
Gets the shape's vertical offset from its upper left corner row.
|
int |
getUpperLeftColumn()
Represents upper left corner column index.
|
int |
getUpperLeftRow()
Represents upper left corner row index.
|
int |
getWidth()
Represents the width of shape, in unit of pixels.
|
double |
getWidthCM()
Represents the width of the shape, in unit of centimeters.
|
double |
getWidthInch()
Represents the width of the shape, in unit of inch.
|
double |
getWidthPt()
Represents the width of the shape, in unit of point.
|
int |
getWidthScale()
Gets the width scale, in unit of percent of the original picture width.
|
int |
getX()
Gets the horizonal offset of shape from worksheet left border,in unit of pixels.
|
int |
getY()
Gets the vertical offset of shape from worksheet top border,in unit of pixels.
|
int |
getZOrderPosition()
Returns the position of a shape in the z-order.
|
boolean |
hasLine()
Gets the line border of the shape is visible.
|
boolean |
isFlippedVertically()
Gets whether shape is vertically flipped .
|
boolean |
isGroup()
Indicates whether the shape is a group.
|
boolean |
isHidden()
Indicates whether the object is visible.
|
boolean |
isLockAspectRatio()
True means that don't allow changes in aspect ratio.
|
boolean |
isLocked()
True if the object is locked, False if the object can be modified when the sheet is protected.
|
boolean |
isTextWrapped()
Gets the text wrapped type of the shape which contains text.
|
void |
move(int upperLeftRow,
int upperLeftColumn)
Moves the picture to a specified location.
|
void |
moveToRange(int upperLeftRow,
int upperLeftColumn,
int lowerRightRow,
int lowerRightColumn)
Moves the shape to a specified range.
|
void |
removeHyperlink()
Remove the hyperlink of the shape.
|
void |
saveToImage(java.io.InputStream s)
Creates the image and saves it to a stream .
|
void |
setAlternativeText(java.lang.String value)
Returns or sets the descriptive (alternative) text string of the
GridShape object. |
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 |
setBottom(int value)
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
|
void |
setData(byte[] value)
Gets the data of the picture.
|
void |
setFlippedVertically(boolean value)
Sets whether shape is vertically flipped .
|
void |
setHasLine(boolean value)
Sets the line border of the shape is visible.
|
void |
setHeight(int value)
Represents the height of shape, in unit of pixel.
|
void |
setHeightCM(double value)
Represents the height of the shape, in unit of inches.
|
void |
setHeightInch(double value)
Represents the height of the shape, in unit of inches.
|
void |
setHeightPt(double value)
Represents the height of the shape, in unit of points.
|
void |
setHeightScale(int value)
Sets the height scale,in unit of percent of the original picture height.
|
void |
setHidden(boolean value)
Indicates whether the object is visible.
|
void |
setHtmlText(java.lang.String value)
Sets the html string which contains data and some formattings in this textbox.
|
void |
setID(java.lang.String value)
Gets /Sets the ID of the picture.
|
void |
setLeft(int value)
Represents the horizontal offset of shape from its left column, in unit of pixels.
|
void |
setLeftCM(double value)
Represents the horizontal offset of shape from its left column, in unit of centimeters.
|
void |
setLeftInch(double value)
Represents the horizontal offset of shape from its left column, in unit of inches.
|
void |
setLeftToCorner(int value)
Represents the horizontal offset of shape from worksheet left board, in unit of pixels.
|
void |
setLinkedCell(java.lang.String value)
Sets the worksheet range linked to the control's value.
|
void |
setLockAspectRatio(boolean value)
True means that don't allow changes in aspect ratio.
|
void |
setLocked(boolean value)
True if the object is locked, False if the object can be modified when the sheet is protected.
|
void |
setLowerDeltaX(int value)
Sets the shape's horizontal offset from its lower right corner column.
|
void |
setLowerDeltaY(int value)
Sets the shape's vertical offset from its lower right corner row.
|
void |
setLowerRightColumn(int value)
Represents lower right corner column index.
|
void |
setLowerRightRow(int value)
Represents lower right corner row index.
|
void |
setName(java.lang.String value)
Sets the name of the shape.
|
void |
setRelativeToOriginalPictureSize(boolean value)
Indicates whether shape is relative to original picture size.
|
void |
setRight(int value)
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
|
void |
setRotationAngle(double value)
Sets the rotation of the shape.
|
void |
setSourceFullName(java.lang.String value)
Sets the path and name of the source file for the linked image.
|
void |
setText(java.lang.String value)
Represents the string in this TextBox object.
|
void |
setTextWrapped(boolean value)
Sets the text wrapped type of the shape which contains text.
|
void |
setTitle(java.lang.String value)
Specifies the title (caption) of the current shape object.
|
void |
setTop(int value)
Represents the vertical offset of shape from its top row, in unit of pixels.
|
void |
setTopCM(double value)
Represents the vertical offset of shape from its top row, in unit of centimeters.
|
void |
setTopInch(double value)
Represents the vertical offset of shape from its top row, in unit of inches.
|
void |
setTopToCorner(int value)
Represents the vertical offset of shape from worksheet top board, in unit of pixels.
|
void |
setUpperDeltaX(int value)
Sets the shape's horizontal offset from its upper left corner column.
|
void |
setUpperDeltaY(int value)
Sets the shape's vertical offset from its upper left corner row.
|
void |
setUpperLeftColumn(int value)
Represents upper left corner column index.
|
void |
setUpperLeftRow(int value)
Represents upper left corner row index.
|
void |
setWidth(int value)
Represents the width of shape, in unit of pixels.
|
void |
setWidthCM(double value)
Represents the width of the shape, in unit of centimeters.
|
void |
setWidthInch(double value)
Represents the width of the shape, in unit of inch.
|
void |
setWidthPt(double value)
Represents the width of the shape, in unit of point.
|
void |
setWidthScale(int value)
Sets the width scale, in unit of percent of the original picture width.
|
void |
setX(int value)
Sets the horizonal offset of shape from worksheet left border,in unit of pixels.
|
void |
setY(int value)
Sets the vertical offset of shape from worksheet top border,in unit of pixels.
|
void |
setZOrderPosition(int value)
Returns the position of a shape in the z-order.
|
public java.lang.String getID()
public void setID(java.lang.String value)
public byte[] getData()
public void setData(byte[] value)
public void move(int upperLeftRow,
int upperLeftColumn)
upperLeftRow - Upper left row index.upperLeftColumn - Upper left column index.public int getOriginalHeight()
public int getOriginalWidth()
public Color getBorderLineColor()
Color of the border line of a picture.public void setBorderLineColor(Color value)
Color of the border line of a picture.public double getBorderWeight()
public void setBorderWeight(double value)
public java.lang.String getSourceFullName()
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.public void setSourceFullName(java.lang.String value)
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.public int getImageFormat()
See GridImageType.
public void saveToImage(java.io.InputStream s)
public double getOriginalHeightCM()
public double getOriginalWidthCM()
public double getOriginalHeightInch()
public double getOriginalWidthInch()
public java.lang.String getName()
public void setName(java.lang.String value)
public boolean isHidden()
public void setHidden(boolean value)
public boolean isLocked()
public void setLocked(boolean value)
public int getHeight()
public void setHeight(int value)
public int getWidth()
public void setWidth(int value)
public int getZOrderPosition()
public void setZOrderPosition(int value)
public boolean isGroup()
public java.lang.String getAlternativeText()
GridShape object.public void setAlternativeText(java.lang.String value)
GridShape object.public java.lang.String getTitle()
public void setTitle(java.lang.String value)
public boolean isLockAspectRatio()
public void setLockAspectRatio(boolean value)
public double getRotationAngle()
public void setRotationAngle(double value)
public GridHyperlink addHyperlink(java.lang.String address)
address - Address of the hyperlink.public void removeHyperlink()
public GridHyperlink getHyperlink()
public void moveToRange(int upperLeftRow,
int upperLeftColumn,
int lowerRightRow,
int lowerRightColumn)
upperLeftRow - Upper left row index.upperLeftColumn - Upper left column index.lowerRightRow - Lower right row indexlowerRightColumn - Lower right column indexpublic int getLeft()
public void setLeft(int value)
public int getLeftToCorner()
public void setLeftToCorner(int value)
public int getTop()
Remarks
If the shape is in the chart, represents the vertical offset of shape from its top border.public void setTop(int value)
Remarks
If the shape is in the chart, represents the vertical offset of shape from its top border.public int getTopToCorner()
public void setTopToCorner(int value)
public int getRight()
public void setRight(int value)
public int getBottom()
public void setBottom(int value)
public void alignTopRightCorner(int topRow,
int rightColumn)
topRow - the row index.rightColumn - the column index.public int getUpperLeftColumn()
public void setUpperLeftColumn(int value)
public int getUpperLeftRow()
Remarks
If the shape is in the shape or in the group , UpperLeftRow will be ignored.public void setUpperLeftRow(int value)
Remarks
If the shape is in the shape or in the group , UpperLeftRow will be ignored.public int getLowerRightColumn()
public void setLowerRightColumn(int value)
public int getLowerRightRow()
public void setLowerRightRow(int value)
public int getUpperDeltaY()
public void setUpperDeltaY(int value)
public int getUpperDeltaX()
public void setUpperDeltaX(int value)
public int getLowerDeltaY()
public void setLowerDeltaY(int value)
public int getLowerDeltaX()
public void setLowerDeltaX(int value)
public double getWidthInch()
public void setWidthInch(double value)
public double getWidthPt()
public void setWidthPt(double value)
public double getWidthCM()
public void setWidthCM(double value)
public double getHeightInch()
public void setHeightInch(double value)
public double getHeightPt()
public void setHeightPt(double value)
public double getHeightCM()
public void setHeightCM(double value)
public double getLeftInch()
public void setLeftInch(double value)
public double getLeftCM()
public void setLeftCM(double value)
public double getTopInch()
public void setTopInch(double value)
public double getTopCM()
public void setTopCM(double value)
public int getX()
public void setX(int value)
public int getY()
public void setY(int value)
public int getWidthScale()
public void setWidthScale(int value)
public int getHeightScale()
public void setHeightScale(int value)
public boolean hasLine()
public void setHasLine(boolean value)
public boolean isFlippedVertically()
public void setFlippedVertically(boolean value)
public boolean getRelativeToOriginalPictureSize()
public void setRelativeToOriginalPictureSize(boolean value)
public java.lang.String getLinkedCell()
public void setLinkedCell(java.lang.String value)
public java.lang.String getText()
public void setText(java.lang.String value)
public java.lang.String getHtmlText()
public void setHtmlText(java.lang.String value)
public boolean isTextWrapped()
public void setTextWrapped(boolean value)
See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© Aspose Pty Ltd 2003-2025. All Rights Reserved.