java.lang.Object
Shape
com.aspose.cells.OleObject
public class OleObject
- extends Shape
Represents an OleObject in a worksheet.
Example:
//Instantiate a new Workbook.
Workbook workbook = new Workbook();
//Get the first worksheet.
Worksheet sheet = workbook.getWorksheets().get(0);
//Define a string variable to store the image path.
String ImageUrl = "C:\\school.jpg";
//Get the picture into the streams.
FileStream fs = File.openRead(ImageUrl);
//Define a byte array.
byte[] imageData = new byte[fs.getLength()];
//Obtain the picture into the array of bytes from streams.
fs.read(imageData, 0, imageData.length);
//Close the stream.
fs.close();
//Get an excel file path in a variable.
String path = "C:\\Book1.xls";
//Get the file into the streams.
fs = File.openRead(path);
//Define an array of bytes.
byte[] objectData = new byte[fs.getLength()];
//Store the file from streams.
fs.read(objectData, 0, objectData.length);
//Close the stream.
fs.close();
//Add an Ole object into the worksheet with the image
//shown in MS Excel.
sheet.getOleObjects().add(14, 3, 200, 220, imageData);
//Set embedded ole object data.
sheet.getOleObjects().get(0).setObjectData(objectData);
//Save the excel file
workbook.save("C:\\oleobjects.xls");
Property Getters/Setters Summary |
int | getActualLowerRightRow() | → inherited from Shape |
|
Get the actual bottom row.
|
java.lang.String | getAlternativeText() | → inherited from Shape |
void | setAlternativeText(java.lang.String value) | |
|
Returns or sets the descriptive (alternative) text string of the Shape object.
|
int | getAutoShapeType() | → inherited from Shape |
void | setAutoShapeType(int value) | |
|
Gets the auto shape type.
The value of the property is AutoShapeType integer constant. |
int | getBottom() | → inherited from Shape |
|
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
|
boolean | getDisplayAsIcon() | |
void | setDisplayAsIcon(boolean value) | |
|
True if the specified object is displayed as an icon
and the image will not be auto changed.
|
int | getFileType() | |
void | setFileType(int value) | |
|
Gets and sets the file type of the embedded ole object data
The value of the property is OleFileType integer constant. |
FillFormat | getFill() | → inherited from Shape |
|
Returns a FillFormat object that contains fill formatting properties for the specified shape.
|
MsoFillFormat | getFillFormat() | → inherited from Shape |
|
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
|
Font | getFont() | → inherited from Shape |
void | setFont(Font value) | |
|
Represents the font of textbox.
|
MsoFormatPicture | getFormatPicture() | → inherited from Shape |
|
Gets and sets the options of the picture format.
|
GroupShape | getGroup() | → inherited from Shape |
|
Gets the group shape which contains this shape.
|
boolean | hasLine() | → inherited from Shape |
void | setHasLine(boolean value) | |
|
Gets and sets the line border of the shape is visible.
|
int | getHeight() | → inherited from Shape |
void | setHeight(int value) | |
|
Represents the height of shape, in unit of pixel.
|
double | getHeightCM() | → inherited from Shape |
void | setHeightCM(double value) | |
|
Represents the height of the shape, in unit of inches.
|
double | getHeightInch() | → inherited from Shape |
void | setHeightInch(double value) | |
|
Represents the height of the shape, in unit of inches.
|
int | getHeightInChart() | → inherited from Shape |
void | setHeightInChart(int value) | |
|
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
|
int | getHeightInShape() | → inherited from Shape |
void | setHeightInShape(int value) | |
|
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
|
double | getHeightPt() | → inherited from Shape |
void | setHeightPt(double value) | |
|
Represents the height of the shape, in unit of points.
|
int | getHeightScale() | → inherited from Shape |
void | setHeightScale(int value) | |
|
Gets and sets the height scale,in unit of percent of the original picture height.
If the shape is not picture ,the HeightScale property only returns 100;
|
java.lang.String | getHtmlText() | → inherited from Shape |
void | setHtmlText(java.lang.String value) | |
|
Gets and sets the html string which contains data and some formattings in this textbox.
|
Hyperlink | getHyperlink() | → inherited from Shape |
|
Gets the hyperlink of the shape.
|
byte[] | getImageData() | |
|
Represents image of ole object as byte array.
|
com.aspose.cells.ImageFormat | getImageFormat() | |
|
Gets the image format of the picture.
|
java.lang.String | getImageSourceFullName() | |
void | setImageSourceFullName(java.lang.String value) | |
|
Gets or sets the path and name of the source file for the linked image.
|
boolean | isAutoSize() | |
void | setAutoSize(boolean value) | |
|
True indicates that the size of the ole object will be auto changed as the size of snapshop of the embedded content
when the ole object is activated.
|
boolean | isFilled() | → inherited from Shape |
void | setFilled(boolean value) | |
|
Indicates whether the fill format is visible.
|
boolean | isFlippedHorizontally() | → inherited from Shape |
void | setFlippedHorizontally(boolean value) | |
|
Gets and sets whether shape is horizontally flipped .
|
boolean | isFlippedVertically() | → inherited from Shape |
void | setFlippedVertically(boolean value) | |
|
Gets and sets whether shape is vertically flipped .
|
boolean | isGroup() | → inherited from Shape |
|
Indicates whether the shape is a group.
|
boolean | isHidden() | → inherited from Shape |
void | setHidden(boolean value) | |
|
Indicates whether the object is visible.
|
boolean | isLink() | |
|
Returns true if the OleObject is linked
|
boolean | isLockAspectRatio() | → inherited from Shape |
void | setLockAspectRatio(boolean value) | |
|
True means that don't allow changes in aspect ratio.
|
boolean | isLocked() | → inherited from Shape |
void | setLocked(boolean value) | |
|
True if the object is locked, False if the object can be modified when the sheet is protected.
|
boolean | isPrintable() | → inherited from Shape |
void | setPrintable(boolean value) | |
|
True if the object is printable
|
boolean | isPrinted() | → inherited from Shape |
void | setPrinted(boolean value) | |
|
True if the object is printable
|
boolean | isTextWrapped() | → inherited from Shape |
void | setTextWrapped(boolean value) | |
|
Gets and sets the text wrapped type of the shape which contains text.
|
boolean | isWordArt() | → inherited from Shape |
|
Indicates whether this shape is a word art.
|
int | getLeft() | → inherited from Shape |
void | setLeft(int value) | |
|
Represents the horizontal offset of shape from its left column, in unit of pixels.
|
double | getLeftCM() | → inherited from Shape |
void | setLeftCM(double value) | |
|
Represents the horizontal offset of shape from its left column, in unit of centimeters.
|
double | getLeftInch() | → inherited from Shape |
void | setLeftInch(double value) | |
|
Represents the horizontal offset of shape from its left column, in unit of inches.
|
int | getLeftInChart() | → inherited from Shape |
void | setLeftInChart(int value) | |
|
Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
|
int | getLeftInShape() | → inherited from Shape |
void | setLeftInShape(int value) | |
|
Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
|
MsoLineFormat | getLineFormat() | → inherited from Shape |
|
Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
|
java.lang.String | getLinkedCell() | → inherited from Shape |
void | setLinkedCell(java.lang.String value) | |
|
Gets or sets the worksheet range linked to the control's value.
|
int | getLowerDeltaX() | → inherited from Shape |
void | setLowerDeltaX(int value) | |
|
Gets or sets the shape's horizontal offset from its lower right corner column.
The range of value is 0 to 1024. |
int | getLowerDeltaY() | → inherited from Shape |
void | setLowerDeltaY(int value) | |
|
Gets or sets the shape's vertical offset from its lower right corner row.
The range of value is 0 to 256. |
int | getLowerRightColumn() | → inherited from Shape |
void | setLowerRightColumn(int value) | |
|
Represents lower right corner column index.
|
int | getLowerRightRow() | → inherited from Shape |
void | setLowerRightRow(int value) | |
|
Represents lower right corner row index.
|
int | getMsoDrawingType() | → inherited from Shape |
|
Gets and sets mso drawing type.
The value of the property is MsoDrawingType integer constant. |
java.lang.String | getName() | → inherited from Shape |
void | setName(java.lang.String value) | |
|
Gets and sets the name of the shape.
|
byte[] | getObjectData() | |
void | setObjectData(byte[] value) | |
|
Represents embedded ole object data as byte array.
|
GeomPathsInfo | getPathsInfo() | → inherited from Shape |
|
Gets path collection information when shape is a NotPrimitive autoshape
|
int | getPlacement() | → inherited from Shape |
void | setPlacement(int value) | |
|
Represents the way the drawing object is attached to the cells below it.
The property controls the placement of an object on a worksheet.
The value of the property is PlacementType integer constant. |
int | getPositionX() | → inherited from Shape |
void | setPositionX(int value) | |
|
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
|
int | getPositionY() | → inherited from Shape |
void | setPositionY(int value) | |
|
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
|
java.lang.String | getProgID() | |
void | setProgID(java.lang.String value) | |
|
Gets or sets the ProgID of the OLE object.
|
boolean | getRelativeToOriginalPictureSize() | → inherited from Shape |
void | setRelativeToOriginalPictureSize(boolean value) | |
|
Indicates whether shape is relative to original picture size.
|
int | getRight() | → inherited from Shape |
|
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
|
int | getRotation() | → inherited from Shape |
void | setRotation(int value) | |
|
Gets and sets the rotation of the shape.
|
double | getRotationAngle() | → inherited from Shape |
void | setRotationAngle(double value) | |
|
Gets and sets the rotation of the shape.
|
java.lang.String | getSourceFullName() | |
void | setSourceFullName(java.lang.String value) | |
|
Returns the source full name of the source file for the linked OLE object.
|
java.lang.String | getText() | → inherited from Shape |
void | setText(java.lang.String value) | |
|
Represents the string in this TextBox object.
|
TextEffectFormat | getTextEffect() | → inherited from Shape |
|
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
Applies to Shape objects that represent WordArt.
|
MsoTextFrame | getTextFrame() | → inherited from Shape |
|
Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
|
int | getTextHorizontalAlignment() | → inherited from Shape |
void | setTextHorizontalAlignment(int value) | |
|
Gets and sets the text horizontal alignment type of the shape.
The value of the property is TextAlignmentType integer constant. |
int | getTextHorizontalOverflow() | → inherited from Shape |
void | setTextHorizontalOverflow(int value) | |
|
Gets and sets the text horizontal overflow type of the shape which contains text.
The value of the property is TextOverflowType integer constant. |
int | getTextOrientationType() | → inherited from Shape |
void | setTextOrientationType(int value) | |
|
Gets and sets the text orientation type of the shape.
The value of the property is TextOrientationType integer constant. |
int | getTextVerticalAlignment() | → inherited from Shape |
void | setTextVerticalAlignment(int value) | |
|
Gets and sets the text vertical alignment type of the shape.
The value of the property is TextAlignmentType integer constant. |
int | getTextVerticalOverflow() | → inherited from Shape |
void | setTextVerticalOverflow(int value) | |
|
Gets and sets the text vertical overflow type of the shape which contains text.
The value of the property is TextOverflowType integer constant. |
java.lang.String | getTitle() | → inherited from Shape |
void | setTitle(java.lang.String value) | |
|
Specifies the title (caption) of the current shape object.
|
int | getTop() | → inherited from Shape |
void | setTop(int value) | |
|
Represents the vertical offset of shape from its top row, in unit of pixels.
|
double | getTopCM() | → inherited from Shape |
void | setTopCM(double value) | |
|
Represents the vertical offset of shape from its top row, in unit of centimeters.
|
double | getTopInch() | → inherited from Shape |
void | setTopInch(double value) | |
|
Represents the vertical offset of shape from its top row, in unit of inches.
|
int | getTopInChart() | → inherited from Shape |
void | setTopInChart(int value) | |
|
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
|
int | getTopInShape() | → inherited from Shape |
void | setTopInShape(int value) | |
|
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
|
int | getType() | → inherited from Shape |
|
Gets the auto shape type.
The value of the property is AutoShapeType integer constant. |
int | getUpperDeltaX() | → inherited from Shape |
void | setUpperDeltaX(int value) | |
|
Gets or sets the shape's horizontal offset from its upper left corner column.
The range of value is 0 to 1024. |
int | getUpperDeltaY() | → inherited from Shape |
void | setUpperDeltaY(int value) | |
|
Gets or sets the shape's vertical offset from its upper left corner row.
The range of value is 0 to 256. |
int | getUpperLeftColumn() | → inherited from Shape |
void | setUpperLeftColumn(int value) | |
|
Represents upper left corner column index.
|
int | getUpperLeftRow() | → inherited from Shape |
void | setUpperLeftRow(int value) | |
|
Represents upper left corner row index.
|
int | getWidth() | → inherited from Shape |
void | setWidth(int value) | |
|
Represents the width of shape, in unit of pixels.
|
double | getWidthCM() | → inherited from Shape |
void | setWidthCM(double value) | |
|
Represents the width of the shape, in unit of centimeters.
|
double | getWidthInch() | → inherited from Shape |
void | setWidthInch(double value) | |
|
Represents the width of the shape, in unit of inch.
|
int | getWidthInChart() | → inherited from Shape |
void | setWidthInChart(int value) | |
|
Represents the width of the shape, in unit of 1/4000 of the parent shape.
|
int | getWidthInShape() | → inherited from Shape |
void | setWidthInShape(int value) | |
|
Represents the width of the shape, in unit of 1/4000 of the parent shape.
|
double | getWidthPt() | → inherited from Shape |
void | setWidthPt(double value) | |
|
Represents the width of the shape, in unit of point.
|
int | getWidthScale() | → inherited from Shape |
void | setWidthScale(int value) | |
|
Gets and sets the width scale, in unit of percent of the original picture width.
If the shape is not picture ,the WidthScale property only returns 100;
|
int | getX() | → inherited from Shape |
void | setX(int value) | |
|
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
|
int | getY() | → inherited from Shape |
void | setY(int value) | |
|
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
|
int | getZOrderPosition() | → inherited from Shape |
void | setZOrderPosition(int value) | |
|
Returns the position of a shape in the z-order.
|
Method Summary |
Hyperlink | addHyperlink(java.lang.String address) | → inherited from Shape |
Adds a hyperlink to the shape.
|
FontSetting | characters(int startIndex, int length) | → inherited from Shape |
Returns a Characters object that represents a range of characters within the text.
|
void | formatCharacters(int startIndex, int length, Font font) | → inherited from Shape |
Format some chararcters with the font setting.
|
java.util.ArrayList | getCharacters() | → inherited from Shape |
Returns all Characters objects
that represents a range of characters within the text .
|
void | moveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn) | → inherited from Shape |
Moves the shape to a specified range.
|
void | removeHyperlink() | → inherited from Shape |
Remove the hyperlink of the shape.
|
void | setNativeSourceFullName(java.lang.String sourceFullName) | |
Sets the ole native source full file name with path.
|
void | toImage(java.io.OutputStream stream, ImageFormat imageFormat) | → inherited from Shape |
Creates the shape image and saves it to a stream in the specified format.
|
void | toImage(java.io.OutputStream stream, ImageOrPrintOptions options) | → inherited from Shape |
Saves the shape to a stream.
|
void | toImage(java.lang.String imageFile, ImageOrPrintOptions options) | → inherited from Shape |
Saves the shape to a file.
|
void | updateSelectedValue() | → inherited from Shape |
Update the selected value by the value of the linked cell.
|
Property Getters/Setters Detail |
isAutoSize/setAutoSize | |
public boolean isAutoSize() / public void setAutoSize(boolean value)
|
-
True indicates that the size of the ole object will be auto changed as the size of snapshop of the embedded content
when the ole object is activated.
isLink | |
public boolean isLink()
|
-
Returns true if the OleObject is linked
getDisplayAsIcon/setDisplayAsIcon | |
public boolean getDisplayAsIcon() / public void setDisplayAsIcon(boolean value)
|
-
True if the specified object is displayed as an icon
and the image will not be auto changed.
getImageData | |
public byte[] getImageData()
|
-
Represents image of ole object as byte array.
getObjectData/setObjectData | |
public byte[] getObjectData() / public void setObjectData(byte[] value)
|
-
Represents embedded ole object data as byte array.
getImageSourceFullName/setImageSourceFullName | |
public java.lang.String getImageSourceFullName() / public void setImageSourceFullName(java.lang.String value)
|
-
Gets or sets the path and name of the source file for the linked image.
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.
getProgID/setProgID | |
public java.lang.String getProgID() / public void setProgID(java.lang.String value)
|
-
Gets or sets the ProgID of the OLE object.
getFileType/setFileType | |
public int getFileType() / public void setFileType(int value)
|
-
Gets and sets the file type of the embedded ole object data
The value of the property is OleFileType integer constant.
OleFileType.MSEquation is read-only.
getSourceFullName/setSourceFullName | |
public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value)
|
-
Returns the source full name of the source file for the linked OLE object.
Only supports setting the source full name when the file type is OleFileType.Unknown.
Such as wav file ,avi file..etc..
getImageFormat | |
public com.aspose.cells.ImageFormat getImageFormat()
|
-
Gets the image format of the picture.
getZOrderPosition/setZOrderPosition | → inherited from Shape |
public int getZOrderPosition() / public void setZOrderPosition(int value)
|
-
Returns the position of a shape in the z-order.
getName/setName | → inherited from Shape |
public java.lang.String getName() / public void setName(java.lang.String value)
|
-
Gets and sets the name of the shape.
getAlternativeText/setAlternativeText | → inherited from Shape |
public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
|
-
Returns or sets the descriptive (alternative) text string of the Shape object.
getTitle/setTitle | → inherited from Shape |
public java.lang.String getTitle() / public void setTitle(java.lang.String value)
|
-
Specifies the title (caption) of the current shape object.
-
Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
-
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
-
Returns a FillFormat object that contains fill formatting properties for the specified shape.
-
Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
-
Gets and sets the options of the picture format.
isHidden/setHidden | → inherited from Shape |
public boolean isHidden() / public void setHidden(boolean value)
|
-
Indicates whether the object is visible.
isLockAspectRatio/setLockAspectRatio | → inherited from Shape |
public boolean isLockAspectRatio() / public void setLockAspectRatio(boolean value)
|
-
True means that don't allow changes in aspect ratio.
getRotation/setRotation | → inherited from Shape |
public int getRotation() / public void setRotation(int value)
|
-
Gets and sets the rotation of the shape.
NOTE: This member is now obsolete. Instead,
please use Shape.RotationAngle property.
This property will be removed 12 months later since June 2010.
Aspose apologizes for any inconvenience you may have experienced.
getRotationAngle/setRotationAngle | → inherited from Shape |
public double getRotationAngle() / public void setRotationAngle(double value)
|
-
Gets and sets the rotation of the shape.
-
Gets the hyperlink of the shape.
isGroup | → inherited from Shape |
public boolean isGroup()
|
-
Indicates whether the shape is a group.
isWordArt | → inherited from Shape |
public boolean isWordArt()
|
-
Indicates whether this shape is a word art.
-
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape.
Applies to Shape objects that represent WordArt.
isLocked/setLocked | → inherited from Shape |
public boolean isLocked() / public void setLocked(boolean value)
|
-
True if the object is locked, False if the object can be modified when the sheet is protected.
isPrintable/setPrintable | → inherited from Shape |
public boolean isPrintable() / public void setPrintable(boolean value)
|
-
True if the object is printable
isPrinted/setPrinted | → inherited from Shape |
public boolean isPrinted() / public void setPrinted(boolean value)
|
-
True if the object is printable
NOTE: This member is now obsolete. Instead,
please use Shape.IsPrintable property.
This property will be removed 12 months later since June 2010.
Aspose apologizes for any inconvenience you may have experienced.
getMsoDrawingType | → inherited from Shape |
public int getMsoDrawingType()
|
-
Gets and sets mso drawing type.
The value of the property is MsoDrawingType integer constant.
getAutoShapeType/setAutoShapeType | → inherited from Shape |
public int getAutoShapeType() / public void setAutoShapeType(int value)
|
-
Gets the auto shape type.
The value of the property is AutoShapeType integer constant.
getPlacement/setPlacement | → inherited from Shape |
public int getPlacement() / public void setPlacement(int value)
|
-
Represents the way the drawing object is attached to the cells below it.
The property controls the placement of an object on a worksheet.
The value of the property is PlacementType integer constant.
getUpperLeftRow/setUpperLeftRow | → inherited from Shape |
public int getUpperLeftRow() / public void setUpperLeftRow(int value)
|
-
Represents upper left corner row index.
If the shape is in the shape or in the group , UpperLeftRow will be ignored.
getUpperDeltaY/setUpperDeltaY | → inherited from Shape |
public int getUpperDeltaY() / public void setUpperDeltaY(int value)
|
-
Gets or sets the shape's vertical offset from its upper left corner row.
The range of value is 0 to 256.
getUpperLeftColumn/setUpperLeftColumn | → inherited from Shape |
public int getUpperLeftColumn() / public void setUpperLeftColumn(int value)
|
-
Represents upper left corner column index.
getUpperDeltaX/setUpperDeltaX | → inherited from Shape |
public int getUpperDeltaX() / public void setUpperDeltaX(int value)
|
-
Gets or sets the shape's horizontal offset from its upper left corner column.
The range of value is 0 to 1024.
getActualLowerRightRow | → inherited from Shape |
public int getActualLowerRightRow()
|
-
Get the actual bottom row.
getLowerRightRow/setLowerRightRow | → inherited from Shape |
public int getLowerRightRow() / public void setLowerRightRow(int value)
|
-
Represents lower right corner row index.
getLowerDeltaY/setLowerDeltaY | → inherited from Shape |
public int getLowerDeltaY() / public void setLowerDeltaY(int value)
|
-
Gets or sets the shape's vertical offset from its lower right corner row.
The range of value is 0 to 256.
getLowerRightColumn/setLowerRightColumn | → inherited from Shape |
public int getLowerRightColumn() / public void setLowerRightColumn(int value)
|
-
Represents lower right corner column index.
getLowerDeltaX/setLowerDeltaX | → inherited from Shape |
public int getLowerDeltaX() / public void setLowerDeltaX(int value)
|
-
Gets or sets the shape's horizontal offset from its lower right corner column.
The range of value is 0 to 1024.
getRight | → inherited from Shape |
public int getRight()
|
-
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
getBottom | → inherited from Shape |
public int getBottom()
|
-
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
getWidth/setWidth | → inherited from Shape |
public int getWidth() / public void setWidth(int value)
|
-
Represents the width of shape, in unit of pixels.
getWidthInch/setWidthInch | → inherited from Shape |
public double getWidthInch() / public void setWidthInch(double value)
|
-
Represents the width of the shape, in unit of inch.
getWidthPt/setWidthPt | → inherited from Shape |
public double getWidthPt() / public void setWidthPt(double value)
|
-
Represents the width of the shape, in unit of point.
getWidthCM/setWidthCM | → inherited from Shape |
public double getWidthCM() / public void setWidthCM(double value)
|
-
Represents the width of the shape, in unit of centimeters.
getHeight/setHeight | → inherited from Shape |
public int getHeight() / public void setHeight(int value)
|
-
Represents the height of shape, in unit of pixel.
getHeightInch/setHeightInch | → inherited from Shape |
public double getHeightInch() / public void setHeightInch(double value)
|
-
Represents the height of the shape, in unit of inches.
getHeightPt/setHeightPt | → inherited from Shape |
public double getHeightPt() / public void setHeightPt(double value)
|
-
Represents the height of the shape, in unit of points.
getHeightCM/setHeightCM | → inherited from Shape |
public double getHeightCM() / public void setHeightCM(double value)
|
-
Represents the height of the shape, in unit of inches.
getLeft/setLeft | → inherited from Shape |
public int getLeft() / public void setLeft(int value)
|
-
Represents the horizontal offset of shape from its left column, in unit of pixels.
getLeftInch/setLeftInch | → inherited from Shape |
public double getLeftInch() / public void setLeftInch(double value)
|
-
Represents the horizontal offset of shape from its left column, in unit of inches.
getLeftCM/setLeftCM | → inherited from Shape |
public double getLeftCM() / public void setLeftCM(double value)
|
-
Represents the horizontal offset of shape from its left column, in unit of centimeters.
getTop/setTop | → inherited from Shape |
public int getTop() / public void setTop(int value)
|
-
Represents the vertical offset of shape from its top row, in unit of pixels.
If the shape is in the chart, represents the vertical offset of shape from its top border.
getTopInch/setTopInch | → inherited from Shape |
public double getTopInch() / public void setTopInch(double value)
|
-
Represents the vertical offset of shape from its top row, in unit of inches.
getTopCM/setTopCM | → inherited from Shape |
public double getTopCM() / public void setTopCM(double value)
|
-
Represents the vertical offset of shape from its top row, in unit of centimeters.
getX/setX | → inherited from Shape |
public int getX() / public void setX(int value)
|
-
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
getY/setY | → inherited from Shape |
public int getY() / public void setY(int value)
|
-
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
getWidthScale/setWidthScale | → inherited from Shape |
public int getWidthScale() / public void setWidthScale(int value)
|
-
Gets and sets the width scale, in unit of percent of the original picture width.
If the shape is not picture ,the WidthScale property only returns 100;
getHeightScale/setHeightScale | → inherited from Shape |
public int getHeightScale() / public void setHeightScale(int value)
|
-
Gets and sets the height scale,in unit of percent of the original picture height.
If the shape is not picture ,the HeightScale property only returns 100;
getTopInShape/setTopInShape | → inherited from Shape |
public int getTopInShape() / public void setTopInShape(int value)
|
-
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
Only Applies when this shape in the group or chart.
getLeftInShape/setLeftInShape | → inherited from Shape |
public int getLeftInShape() / public void setLeftInShape(int value)
|
-
Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
Only Applies when this shape in the group or chart.
getWidthInShape/setWidthInShape | → inherited from Shape |
public int getWidthInShape() / public void setWidthInShape(int value)
|
-
Represents the width of the shape, in unit of 1/4000 of the parent shape.
Only Applies when this shape in the group or chart.
getHeightInShape/setHeightInShape | → inherited from Shape |
public int getHeightInShape() / public void setHeightInShape(int value)
|
-
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
Only Applies when this shape in the group or chart.
getHeightInChart/setHeightInChart | → inherited from Shape |
public int getHeightInChart() / public void setHeightInChart(int value)
|
-
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
NOTE: This member is now obsolete. Instead,
please use Aspose.Cells.Drawing.Shape.HeightInShape property.
This property will be removed 12 months later since JANUARY 2012.
Aspose apologizes for any inconvenience you may have experienced.
getLeftInChart/setLeftInChart | → inherited from Shape |
public int getLeftInChart() / public void setLeftInChart(int value)
|
-
Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
NOTE: This member is now obsolete. Instead,
please use Aspose.Cells.Drawing.Shape.LeftInShape property.
This property will be removed 12 months later since JANUARY 2012.
Aspose apologizes for any inconvenience you may have experienced.
getTopInChart/setTopInChart | → inherited from Shape |
public int getTopInChart() / public void setTopInChart(int value)
|
-
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
NOTE: This member is now obsolete. Instead,
please use Aspose.Cells.Drawing.Shape.TopInShape property.
This property will be removed 12 months later since JANUARY 2012.
Aspose apologizes for any inconvenience you may have experienced.
getWidthInChart/setWidthInChart | → inherited from Shape |
public int getWidthInChart() / public void setWidthInChart(int value)
|
-
Represents the width of the shape, in unit of 1/4000 of the parent shape.
NOTE: This member is now obsolete. Instead,
please use Aspose.Cells.Drawing.Shape.WidthInShape property.
This property will be removed 12 months later since JANUARY 2012.
Aspose apologizes for any inconvenience you may have experienced.
getPositionX/setPositionX | → inherited from Shape |
public int getPositionX() / public void setPositionX(int value)
|
-
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
NOTE: This member is now obsolete. Instead,
please use Aspose.Cells.Drawing.Shape.X property.
This property will be removed 12 months later since JANUARY 2012.
Aspose apologizes for any inconvenience you may have experienced.
getPositionY/setPositionY | → inherited from Shape |
public int getPositionY() / public void setPositionY(int value)
|
-
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
NOTE: This member is now obsolete. Instead,
please use Aspose.Cells.Drawing.Shape.Y property.
This property will be removed 12 months later since JANUARY 2012.
Aspose apologizes for any inconvenience you may have experienced.
-
Gets the group shape which contains this shape.
getType | → inherited from Shape |
public int getType()
|
-
Gets the auto shape type.
The value of the property is AutoShapeType integer constant.
hasLine/setHasLine | → inherited from Shape |
public boolean hasLine() / public void setHasLine(boolean value)
|
-
Gets and sets the line border of the shape is visible.
isFilled/setFilled | → inherited from Shape |
public boolean isFilled() / public void setFilled(boolean value)
|
-
Indicates whether the fill format is visible.
isFlippedHorizontally/setFlippedHorizontally | → inherited from Shape |
public boolean isFlippedHorizontally() / public void setFlippedHorizontally(boolean value)
|
-
Gets and sets whether shape is horizontally flipped .
isFlippedVertically/setFlippedVertically | → inherited from Shape |
public boolean isFlippedVertically() / public void setFlippedVertically(boolean value)
|
-
Gets and sets whether shape is vertically flipped .
getRelativeToOriginalPictureSize/setRelativeToOriginalPictureSize | → inherited from Shape |
public boolean getRelativeToOriginalPictureSize() / public void setRelativeToOriginalPictureSize(boolean value)
|
-
Indicates whether shape is relative to original picture size.
getLinkedCell/setLinkedCell | → inherited from Shape |
public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)
|
-
Gets or sets the worksheet range linked to the control's value.
getFont/setFont | → inherited from Shape |
public Font getFont() / public void setFont(Font value)
|
-
Represents the font of textbox.
getText/setText | → inherited from Shape |
public java.lang.String getText() / public void setText(java.lang.String value)
|
-
Represents the string in this TextBox object.
getHtmlText/setHtmlText | → inherited from Shape |
public java.lang.String getHtmlText() / public void setHtmlText(java.lang.String value)
|
-
Gets and sets the html string which contains data and some formattings in this textbox.
getTextVerticalOverflow/setTextVerticalOverflow | → inherited from Shape |
public int getTextVerticalOverflow() / public void setTextVerticalOverflow(int value)
|
-
Gets and sets the text vertical overflow type of the shape which contains text.
The value of the property is TextOverflowType integer constant.
getTextHorizontalOverflow/setTextHorizontalOverflow | → inherited from Shape |
public int getTextHorizontalOverflow() / public void setTextHorizontalOverflow(int value)
|
-
Gets and sets the text horizontal overflow type of the shape which contains text.
The value of the property is TextOverflowType integer constant.
isTextWrapped/setTextWrapped | → inherited from Shape |
public boolean isTextWrapped() / public void setTextWrapped(boolean value)
|
-
Gets and sets the text wrapped type of the shape which contains text.
getTextOrientationType/setTextOrientationType | → inherited from Shape |
public int getTextOrientationType() / public void setTextOrientationType(int value)
|
-
Gets and sets the text orientation type of the shape.
The value of the property is TextOrientationType integer constant.
getTextHorizontalAlignment/setTextHorizontalAlignment | → inherited from Shape |
public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
|
-
Gets and sets the text horizontal alignment type of the shape.
The value of the property is TextAlignmentType integer constant.
getTextVerticalAlignment/setTextVerticalAlignment | → inherited from Shape |
public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
|
-
Gets and sets the text vertical alignment type of the shape.
The value of the property is TextAlignmentType integer constant.
-
Gets path collection information when shape is a NotPrimitive autoshape
setNativeSourceFullName | |
public void setNativeSourceFullName(java.lang.String sourceFullName) |
-
Sets the ole native source full file name with path.
- Parameters:
sourceFullName
- the ole native source full file name
toImage | → inherited from Shape |
public void toImage(java.io.OutputStream stream, ImageFormat imageFormat)
throws java.lang.Exception |
-
Creates the shape image and saves it to a stream in the specified format.
The following formats are supported:
.bmp, .gif, .jpg, .jpeg, .tiff, .emf.
- Parameters:
stream
- The output stream.imageFormat
- The format in which to save the image.
toImage | → inherited from Shape |
public void toImage(java.lang.String imageFile, ImageOrPrintOptions options)
throws java.lang.Exception |
-
Saves the shape to a file.
toImage | → inherited from Shape |
public void toImage(java.io.OutputStream stream, ImageOrPrintOptions options)
throws java.lang.Exception |
-
Saves the shape to a stream.
updateSelectedValue | → inherited from Shape |
public void updateSelectedValue()
throws java.lang.Exception |
-
Update the selected value by the value of the linked cell.
formatCharacters | → inherited from Shape |
public void formatCharacters(int startIndex, int length, Font font) |
-
Format some chararcters with the font setting.
- Parameters:
startIndex
- The start index.length
- The the length.font
- The font setting.
characters | → inherited from Shape |
public FontSetting characters(int startIndex, int length) |
-
Returns a Characters object that represents a range of characters within the text.
This method only works on shape with title.
- Parameters:
startIndex
- The index of the start of the character.length
- The number of characters.
- Returns:
- Characters object.
getCharacters | → inherited from Shape |
public java.util.ArrayList getCharacters() |
-
Returns all Characters objects
that represents a range of characters within the text .
- Returns:
- All Characters objects
addHyperlink | → inherited from Shape |
public Hyperlink addHyperlink(java.lang.String address) |
-
Adds a hyperlink to the shape.
- Parameters:
address
- Address of the hyperlink.
- Returns:
- Return the new hyperlink object.
removeHyperlink | → inherited from Shape |
public void removeHyperlink() |
-
Remove the hyperlink of the shape.
moveToRange | → inherited from Shape |
public void moveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn) |
-
Moves the shape to a specified range.
- Parameters:
upperLeftRow
- Upper left row index.upperLeftColumn
- Upper left column index.lowerRightRow
- Lower right row indexlowerRightColumn
- Lower right column index
See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.