asposecells.api

Class Picture

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

Example:

# Instantiating a Workbook object
workbook = Workbook()
# Adding a new worksheet to the Workbook object
sheetIndex = workbook.getWorksheets().add()
# Obtaining the reference of the newly added worksheet by passing its sheet index
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, "cells.png")
# Saving the Excel file
workbook.save("Book1.xls", SaveFormat.EXCEL_97_TO_2003)

Property Getters/Setters Summary
methodgetActualLowerRightRow()
Get the actual bottom row.
methodgetAlternativeText()
method
           Returns or sets the descriptive (alternative) text string of the Shape object.
methodgetAnchorType()
method
           Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
methodgetAutoShapeType()
method
           Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
methodgetBorderLineColor()
method
           Represents the com.aspose.cells.Color of the border line of a picture.
methodgetBorderWeight()
method
           Gets or sets the weight of the border line of a picture in units of pt.
methodgetBottom()
method
setBottom(value)
           Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
methodgetControlData()
Gets the data of control.
methodgetCreateId()
method
           Gets and sets create id for this shape.
methodgetData()
method
setData(value)
           Gets the data of the picture.
methodgetDisplayAsIcon()
method
           True if the specified object is displayed as an icon and the image will not be auto changed.
methodgetFill()
Returns a FillFormat object that contains fill formatting properties for the specified shape.
methodgetFillFormat()
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
methodgetFont()
method
setFont(value)
           Represents the font of shape.
methodgetFormatPicture()
Gets and sets the options of the picture format.
methodgetFormula()
method
setFormula(value)
           Gets and sets the data of the formula.
methodgetGeometry()
Gets the geometry
methodgetGlow()
Represents a GlowEffect object that specifies glow effect for the chart element or shape.
methodgetGroup()
Gets the group shape which contains this shape.
methodhasLine()
method
setHasLine(value)
           Gets and sets the line border of the shape is visible.
methodgetHeight()
method
setHeight(value)
           Represents the height of shape, in unit of pixel.
methodgetHeightCM()
method
           Represents the height of the shape, in unit of centimeters.
methodgetHeightInch()
method
           Represents the height of the shape, in unit of inches.
methodgetHeightInShape()
method
           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..
methodgetHeightPt()
method
           Represents the height of the shape, in unit of points.
methodgetHeightScale()
method
           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;
methodgetHtmlText()
method
           Gets and sets the html string which contains data and some formats in this textbox.
methodgetHyperlink()
Gets the hyperlink of the shape.
methodgetId()
Gets the identifier of this shape.
methodgetImageType()
Gets the image format of the picture. The value of the property is ImageType integer constant.
methodgetInputRange()
method
           Gets or sets the worksheet range used to fill the specified combo box.
methodisAspectRatioLocked()
method
           True means that aspect ratio of the shape is locked.
methodisAutoSize()
method
           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.
methodisDynamicDataExchange()
method
           Gets or sets whether dynamic data exchange
methodisEquation()
Indicates whether the shape only contains an equation.
methodisFilled()
method
setFilled(value)
           Indicates whether the fill format is visible.
methodisFlippedHorizontally()
method
           Gets and sets whether shape is horizontally flipped .
methodisFlippedVertically()
method
           Gets and sets whether shape is vertically flipped .
methodisGroup()
Indicates whether this shape is a group shape.
methodisHidden()
method
setHidden(value)
           Indicates whether the object is visible.
methodisInGroup()
Indicates whether the shape is grouped.
methodisLink()
method
setLink(value)
           Returns true if the picture is linked to a file.
methodisLockAspectRatio()
method
           True means that aspect ratio of the shape is locked.
methodisLocked()
method
setLocked(value)
           True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.
methodisPrintable()
method
           Indicates whether the object is printable. If False, this shape will not be printed when printing.
methodisRichText()
Whether or not the text is rich text.
methodisSmartArt()
Indicates whether the shape is a smart art.
methodisTextWrapped()
method
           Gets and sets the text wrapped type of the shape which contains text.
methodisWordArt()
Indicates whether this shape is a word art.
methodgetLeft()
method
setLeft(value)
           Represents the horizontal offset of shape from its left column, in unit of pixels.
methodgetLeftCM()
method
setLeftCM(value)
           Represents the horizontal offset of shape from its left column, in unit of centimeters.
methodgetLeftInch()
method
           Represents the horizontal offset of shape from its left column, in unit of inches.
methodgetLeftInShape()
method
           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.
methodgetLeftToCorner()
method
           Gets and sets the horizonal offset of shape from worksheet left border.
methodgetLine()
Gets line style
methodgetLineFormat()
Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
methodgetLinkedCell()
method
           Gets or sets the worksheet range linked to the control's value.
methodgetLowerDeltaX()
method
           Gets or sets the shape's horizontal offset from its lower right corner column.
methodgetLowerDeltaY()
method
           Gets or sets the shape's vertical offset from its lower right corner row.
methodgetLowerRightColumn()
method
           Represents lower right corner column index.
methodgetLowerRightRow()
method
           Represents lower right corner row index.
methodgetMacroName()
method
           Gets and sets the name of macro.
methodgetMsoDrawingType()
Gets drawing type. The value of the property is MsoDrawingType integer constant.
methodgetName()
method
setName(value)
           Gets and sets the name of the shape.
methodgetOriginalHeight()
Gets the original height of the picture.
methodgetOriginalHeightCM()
Gets the original height of picture, in unit of centimeters.
methodgetOriginalHeightInch()
Gets the original height of picture, in unit of inches.
methodgetOriginalWidth()
Gets the original width of the picture.
methodgetOriginalWidthCM()
Gets the original width of picture, in unit of centimeters.
methodgetOriginalWidthInch()
Gets the original width of picture, in unit of inches.
methodgetPaths()
Gets the paths of a custom geometric shape.
methodgetPlacement()
method
           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.
methodgetReflection()
Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
methodgetRelativeToOriginalPictureSize()
method
           Indicates whether shape is relative to original picture size.
methodgetRight()
method
setRight(value)
           Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
methodgetRotationAngle()
method
           Gets and sets the rotation of the shape.
methodgetShadowEffect()
Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
methodgetSignatureLine()
method
           Gets and sets the signature line
methodgetSoftEdges()
method
           Gets and sets the radius of blur to apply to the edges, in unit of points.
methodgetSourceFullName()
method
           Gets or sets the path and name of the source file for the linked image.
methodgetSpid()
Specifies an optional string identifier that an application can use to identify the particular shape.
methodgetSpt()
Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
methodgetText()
method
setText(value)
           Gets and sets the text of this shape.
methodgetTextBody()
Gets and sets the setting of the shape's text.
methodgetTextDirection()
method
           Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
methodgetTextEffect()
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
methodgetTextHorizontalAlignment()
method
           Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
methodgetTextHorizontalOverflow()
method
           Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
methodgetTextOptions()
method
           Represents the text options of the shape.
methodgetTextOrientationType()
method
           Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
methodgetTextShapeType()
method
           Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
methodgetTextVerticalAlignment()
method
           Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
methodgetTextVerticalOverflow()
method
           Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
methodgetThreeDFormat()
Gets and sets 3d format of the shape.
methodgetTitle()
method
setTitle(value)
           Specifies the title (caption) of the current shape object.
methodgetTop()
method
setTop(value)
           Represents the vertical offset of shape from its top row, in unit of pixels.
methodgetTopCM()
method
setTopCM(value)
           Represents the vertical offset of shape from its top row, in unit of centimeters.
methodgetTopInch()
method
setTopInch(value)
           Represents the vertical offset of shape from its top row, in unit of inches.
methodgetTopInShape()
method
           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.
methodgetTopToCorner()
method
           Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
methodgetType()
Gets the auto shape type. The value of the property is AutoShapeType integer constant.
methodgetUpperDeltaX()
method
           Gets or sets the shape's horizontal offset from its upper left corner column.
methodgetUpperDeltaY()
method
           Gets or sets the shape's vertical offset from its upper left corner row.
methodgetUpperLeftColumn()
method
           Represents upper left corner column index.
methodgetUpperLeftRow()
method
           Represents the top row index.
methodgetWidth()
method
setWidth(value)
           Represents the width of shape, in unit of pixels.
methodgetWidthCM()
method
setWidthCM(value)
           Represents the width of the shape, in unit of centimeters.
methodgetWidthInch()
method
           Represents the width of the shape, in unit of inch.
methodgetWidthInShape()
method
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
methodgetWidthPt()
method
setWidthPt(value)
           Represents the width of the shape, in unit of point.
methodgetWidthScale()
method
           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;
methodgetWorksheet()
Gets the Worksheet object which contains this shape.
methodgetX()
method
setX(value)
           Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
methodgetY()
method
setY(value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
methodgetZOrderPosition()
method
           Returns the position of a shape in the z-order.
 
Method Summary
methodaddHyperlink(address)
Adds a hyperlink to the shape.
methodalignTopRightCorner(topRow, rightColumn)
Moves the picture to the top-right corner.
methodcalculateTextSize()
Recalculate the text area
methodcharacters(startIndex, length)
Returns a Characters object that represents a range of characters within the text.
methodcopy(source, options)
Copy the picture.
methodformatCharacters(startIndex, length, font, flag)
Formats some characters with the font setting.
methodgetActualBox()
Get the actual position and size of the shape (after applying rotation, flip, etc.)
methodgetCharacters()
Returns all Characters objects that represents a range of characters within the text .
methodgetConnectionPoints()
Get the connection points
methodgetInputRange(isR1C1, isLocal)
Gets the range used to fill the control.
methodgetLinkedCell(isR1C1, isLocal)
Gets the range linked to the control's value.
methodgetLockedProperty(type)
Gets the value of locked property.
methodgetResultOfSmartArt()
Converting smart art to grouped shapes.
methodgetRichFormattings()
Returns all Characters objects that represents a range of characters within the text .
methodisSameSetting(obj)
Returns whether the shape is same.
methodmove(upperLeftRow, upperLeftColumn)
Moves the picture to a specified location.
methodmoveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)
Moves the shape to a specified range.
methodremoveActiveXControl()
Remove activeX control.
methodremoveHyperlink()
Removes the hyperlink of the shape.
methodsetInputRange(formula, isR1C1, isLocal)
Sets the range used to fill the control.
methodsetLinkedCell(formula, isR1C1, isLocal)
Sets the range linked to the control's value.
methodsetLockedProperty(type, value)
Set the locked property.
methodtoFrontOrBack(orders)
Brings the shape to the front or sends the shape to back.
methodtoImage(imageFile, options)
Saves the shape to a file.
methodupdateSelectedValue()
Update the selected value by the value of the linked cell.
 

    • Property Getters/Setters Detail

      • getOriginalHeight : int 

        int getOriginalHeight()
        
        Gets the original height of the picture.
      • getOriginalWidth : int 

        int getOriginalWidth()
        
        Gets the original width of the picture.
      • getBorderLineColor/setBorderLineColor : Color 

        Color getBorderLineColor() / setBorderLineColor(value)
        
        Represents the com.aspose.cells.Color of the border line of a picture.
      • getBorderWeight/setBorderWeight : float 

        float getBorderWeight() / setBorderWeight(value)
        
        Gets or sets the weight of the border line of a picture in units of pt.
      • getData/setData : byte[] 

        byte[] getData() / setData(value)
        
        Gets the data of the picture.
      • getSourceFullName/setSourceFullName : String 

        String getSourceFullName() / setSourceFullName(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.
      • getFormula/setFormula : String 

        String getFormula() / setFormula(value)
        
        Gets and sets the data of the formula.
      • isAutoSize/setAutoSize : boolean 

        boolean isAutoSize() / setAutoSize(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/setLink : boolean 

        boolean isLink() / setLink(value)
        
        Returns true if the picture is linked to a file.
      • isDynamicDataExchange/setDynamicDataExchange : boolean 

        boolean isDynamicDataExchange() / setDynamicDataExchange(value)
        
        Gets or sets whether dynamic data exchange
      • getDisplayAsIcon/setDisplayAsIcon : boolean 

        boolean getDisplayAsIcon() / setDisplayAsIcon(value)
        
        True if the specified object is displayed as an icon and the image will not be auto changed.
      • getImageType : int 

        int getImageType()
        
        Gets the image format of the picture. The value of the property is ImageType integer constant.
      • getOriginalHeightCM : float 

        float getOriginalHeightCM()
        
        Gets the original height of picture, in unit of centimeters.
      • getOriginalWidthCM : float 

        float getOriginalWidthCM()
        
        Gets the original width of picture, in unit of centimeters.
      • getOriginalHeightInch : float 

        float getOriginalHeightInch()
        
        Gets the original height of picture, in unit of inches.
      • getOriginalWidthInch : float 

        float getOriginalWidthInch()
        
        Gets the original width of picture, in unit of inches.
      • getSignatureLine/setSignatureLine : SignatureLine 

        SignatureLine getSignatureLine() / setSignatureLine(value)
        
        Gets and sets the signature line
      • getMacroName/setMacroName : String 

        String getMacroName() / setMacroName(value)
        
        Gets and sets the name of macro.
      • isEquation : boolean 

        boolean isEquation()
        
        Indicates whether the shape only contains an equation.
      • isSmartArt : boolean 

        boolean isSmartArt()
        
        Indicates whether the shape is a smart art. Only for ooxml file.
      • getZOrderPosition/setZOrderPosition : int 

        int getZOrderPosition() / setZOrderPosition(value)
        
        Returns the position of a shape in the z-order.
      • getName/setName : String 

        String getName() / setName(value)
        
        Gets and sets the name of the shape.
      • getAlternativeText/setAlternativeText : String 

        String getAlternativeText() / setAlternativeText(value)
        
        Returns or sets the descriptive (alternative) text string of the Shape object.
      • getTitle/setTitle : String 

        String getTitle() / setTitle(value)
        
        Specifies the title (caption) of the current shape object.
      • getLineFormat : MsoLineFormat 

        MsoLineFormat getLineFormat()
        
        Returns a MsoLineFormat object that contains line formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Line property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
      • getFillFormat : MsoFillFormat 

        MsoFillFormat getFillFormat()
        
        Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Fill property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.
      • getSoftEdges/setSoftEdges : float 

        float getSoftEdges() / setSoftEdges(value)
        
        Gets and sets the radius of blur to apply to the edges, in unit of points.
      • isHidden/setHidden : boolean 

        boolean isHidden() / setHidden(value)
        
        Indicates whether the object is visible.
      • isLockAspectRatio/setLockAspectRatio : boolean 

        boolean isLockAspectRatio() / setLockAspectRatio(value)
        
        True means that aspect ratio of the shape is locked. Only for pictures and Ole Objects. NOTE: This member is now obsolete. Instead, please use Shape.IsAspectRatioLocked property. This property will be removed 12 months later since July 2024. Aspose apologizes for any inconvenience you may have experienced.
      • isAspectRatioLocked/setAspectRatioLocked : boolean 

        boolean isAspectRatioLocked() / setAspectRatioLocked(value)
        
        True means that aspect ratio of the shape is locked. Only for pictures and Ole Objects.
      • getRotationAngle/setRotationAngle : float 

        float getRotationAngle() / setRotationAngle(value)
        
        Gets and sets the rotation of the shape.
      • getId : int 

        int getId()
        
        Gets the identifier of this shape.
      • getSpid : String 

        String getSpid()
        
        Specifies an optional string identifier that an application can use to identify the particular shape.
      • getSpt : int 

        int getSpt()
        
        Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
      • isGroup : boolean 

        boolean isGroup()
        
        Indicates whether this shape is a group shape.
      • isInGroup : boolean 

        boolean isInGroup()
        
        Indicates whether the shape is grouped.
      • isWordArt : boolean 

        boolean isWordArt()
        
        Indicates whether this shape is a word art. Only for the Legacy Shape of xls file.
      • getTextEffect : TextEffectFormat 

        TextEffectFormat getTextEffect()
        
        Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
      • isLocked/setLocked : boolean 

        boolean isLocked() / setLocked(value)
        
        True means the object can not be modified when the sheet is protected. Note that this value is meaningful only if the worksheet or objects in the worksheet are protected.
      • isPrintable/setPrintable : boolean 

        boolean isPrintable() / setPrintable(value)
        
        Indicates whether the object is printable. If False, this shape will not be printed when printing.
      • getMsoDrawingType : int 

        int getMsoDrawingType()
        
        Gets drawing type. The value of the property is MsoDrawingType integer constant.
      • getAutoShapeType/setAutoShapeType : int 

        int getAutoShapeType() / setAutoShapeType(value)
        
        Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
      • getAnchorType/setAnchorType : int 

        int getAnchorType() / setAnchorType(value)
        
        Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
      • getPlacement/setPlacement : int 

        int getPlacement() / setPlacement(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 : int 

        int getUpperLeftRow() / setUpperLeftRow(value)
        
        Represents the top row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.
      • getUpperDeltaY/setUpperDeltaY : int 

        int getUpperDeltaY() / setUpperDeltaY(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 : int 

        int getUpperLeftColumn() / setUpperLeftColumn(value)
        
        Represents upper left corner column index.
      • getUpperDeltaX/setUpperDeltaX : int 

        int getUpperDeltaX() / setUpperDeltaX(value)
        
        Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.
      • getLowerRightRow/setLowerRightRow : int 

        int getLowerRightRow() / setLowerRightRow(value)
        
        Represents lower right corner row index.
      • getLowerDeltaY/setLowerDeltaY : int 

        int getLowerDeltaY() / setLowerDeltaY(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 : int 

        int getLowerRightColumn() / setLowerRightColumn(value)
        
        Represents lower right corner column index.
      • getLowerDeltaX/setLowerDeltaX : int 

        int getLowerDeltaX() / setLowerDeltaX(value)
        
        Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.
      • getRight/setRight : int 

        int getRight() / setRight(value)
        
        Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
      • getBottom/setBottom : int 

        int getBottom() / setBottom(value)
        
        Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
      • getWidth/setWidth : int 

        int getWidth() / setWidth(value)
        
        Represents the width of shape, in unit of pixels.
      • getWidthInch/setWidthInch : float 

        float getWidthInch() / setWidthInch(value)
        
        Represents the width of the shape, in unit of inch.
      • getWidthPt/setWidthPt : float 

        float getWidthPt() / setWidthPt(value)
        
        Represents the width of the shape, in unit of point.
      • getWidthCM/setWidthCM : float 

        float getWidthCM() / setWidthCM(value)
        
        Represents the width of the shape, in unit of centimeters.
      • getHeight/setHeight : int 

        int getHeight() / setHeight(value)
        
        Represents the height of shape, in unit of pixel.
      • getHeightInch/setHeightInch : float 

        float getHeightInch() / setHeightInch(value)
        
        Represents the height of the shape, in unit of inches.
      • getHeightPt/setHeightPt : float 

        float getHeightPt() / setHeightPt(value)
        
        Represents the height of the shape, in unit of points.
      • getHeightCM/setHeightCM : float 

        float getHeightCM() / setHeightCM(value)
        
        Represents the height of the shape, in unit of centimeters.
      • getLeft/setLeft : int 

        int getLeft() / setLeft(value)
        
        Represents the horizontal offset of shape from its left column, in unit of pixels.
      • getLeftInch/setLeftInch : float 

        float getLeftInch() / setLeftInch(value)
        
        Represents the horizontal offset of shape from its left column, in unit of inches.
      • getLeftCM/setLeftCM : float 

        float getLeftCM() / setLeftCM(value)
        
        Represents the horizontal offset of shape from its left column, in unit of centimeters.
      • getTop/setTop : int 

        int getTop() / setTop(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 : float 

        float getTopInch() / setTopInch(value)
        
        Represents the vertical offset of shape from its top row, in unit of inches.
      • getTopCM/setTopCM : float 

        float getTopCM() / setTopCM(value)
        
        Represents the vertical offset of shape from its top row, in unit of centimeters.
      • getTopToCorner/setTopToCorner : int 

        int getTopToCorner() / setTopToCorner(value)
        
        Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
      • getLeftToCorner/setLeftToCorner : int 

        int getLeftToCorner() / setLeftToCorner(value)
        
        Gets and sets the horizonal offset of shape from worksheet left border.
      • getX/setX : int 

        int getX() / setX(value)
        
        Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
      • getY/setY : int 

        int getY() / setY(value)
        
        Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
      • getWidthScale/setWidthScale : int 

        int getWidthScale() / setWidthScale(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 : int 

        int getHeightScale() / setHeightScale(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 : int 

        int getTopInShape() / setTopInShape(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 : int 

        int getLeftInShape() / setLeftInShape(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 : int 

        int getWidthInShape() / setWidthInShape(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 : int 

        int getHeightInShape() / setHeightInShape(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.
      • getType : int 

        int getType()
        
        Gets the auto shape type. The value of the property is AutoShapeType integer constant.
      • hasLine/setHasLine : boolean 

        boolean hasLine() / setHasLine(value)
        
        Gets and sets the line border of the shape is visible.
      • isFilled/setFilled : boolean 

        boolean isFilled() / setFilled(value)
        
        Indicates whether the fill format is visible.
      • isFlippedHorizontally/setFlippedHorizontally : boolean 

        boolean isFlippedHorizontally() / setFlippedHorizontally(value)
        
        Gets and sets whether shape is horizontally flipped .
      • isFlippedVertically/setFlippedVertically : boolean 

        boolean isFlippedVertically() / setFlippedVertically(value)
        
        Gets and sets whether shape is vertically flipped .
      • getActualLowerRightRow : int 

        int getActualLowerRightRow()
        
        Get the actual bottom row.
      • getRelativeToOriginalPictureSize/setRelativeToOriginalPictureSize : boolean 

        boolean getRelativeToOriginalPictureSize() / setRelativeToOriginalPictureSize(value)
        
        Indicates whether shape is relative to original picture size.
      • getLinkedCell/setLinkedCell : String 

        String getLinkedCell() / setLinkedCell(value)
        
        Gets or sets the worksheet range linked to the control's value.
      • getInputRange/setInputRange : String 

        String getInputRange() / setInputRange(value)
        
        Gets or sets the worksheet range used to fill the specified combo box.
      • getTextShapeType/setTextShapeType : int 

        int getTextShapeType() / setTextShapeType(value)
        
        Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
      • getFont/setFont : Font 

        Font getFont() / setFont(value)
        
        Represents the font of shape.
      • getTextOptions/setTextOptions : TextOptions 

        TextOptions getTextOptions() / setTextOptions(value)
        
        Represents the text options of the shape.
      • getText/setText : String 

        String getText() / setText(value)
        
        Gets and sets the text of this shape.
      • isRichText : boolean 

        boolean isRichText()
        
        Whether or not the text is rich text.
      • getHtmlText/setHtmlText : String 

        String getHtmlText() / setHtmlText(value)
        
        Gets and sets the html string which contains data and some formats in this textbox.
      • getTextVerticalOverflow/setTextVerticalOverflow : int 

        int getTextVerticalOverflow() / setTextVerticalOverflow(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 : int 

        int getTextHorizontalOverflow() / setTextHorizontalOverflow(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 : boolean 

        boolean isTextWrapped() / setTextWrapped(value)
        
        Gets and sets the text wrapped type of the shape which contains text.
      • getTextOrientationType/setTextOrientationType : int 

        int getTextOrientationType() / setTextOrientationType(value)
        
        Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
      • getTextHorizontalAlignment/setTextHorizontalAlignment : int 

        int getTextHorizontalAlignment() / setTextHorizontalAlignment(value)
        
        Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
      • getTextVerticalAlignment/setTextVerticalAlignment : int 

        int getTextVerticalAlignment() / setTextVerticalAlignment(value)
        
        Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
      • getTextDirection/setTextDirection : int 

        int getTextDirection() / setTextDirection(value)
        
        Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
      • getControlData : byte[] 

        byte[] getControlData()
        
        Gets the data of control.
      • getCreateId/setCreateId : UUID 

        UUID getCreateId() / setCreateId(value)
        
        Gets and sets create id for this shape.
    • Method Detail

      • copy

         copy(source, options)
        Copy the picture.
        Parameters:
        source: Picture - The source picture.
        options: CopyOptions - The copy options.
      • move

         move(upperLeftRow, upperLeftColumn)
        Moves the picture to a specified location.
        Parameters:
        upperLeftRow: int - Upper left row index.
        upperLeftColumn: int - Upper left column index.
      • isSameSetting

        boolean isSameSetting(obj)
        Returns whether the shape is same.
        Parameters:
        obj: Object -
        Returns:
      • getLinkedCell

        String getLinkedCell(isR1C1, isLocal)
        Gets the range linked to the control's value.
        Parameters:
        isR1C1: boolean - Whether the formula needs to be formatted as R1C1.
        isLocal: boolean - Whether the formula needs to be formatted by locale.
        Returns:
        The range linked to the control's value.
      • setLinkedCell

         setLinkedCell(formula, isR1C1, isLocal)
        Sets the range linked to the control's value.
        Parameters:
        formula: String - The range linked to the control's value.
        isR1C1: boolean - Whether the formula needs to be formatted as R1C1.
        isLocal: boolean - Whether the formula needs to be formatted by locale.
      • getInputRange

        String getInputRange(isR1C1, isLocal)
        Gets the range used to fill the control.
        Parameters:
        isR1C1: boolean - Whether the formula needs to be formatted as R1C1.
        isLocal: boolean - Whether the formula needs to be formatted by locale.
        Returns:
        The range used to fill the control.
      • setInputRange

         setInputRange(formula, isR1C1, isLocal)
        Sets the range used to fill the control.
        Parameters:
        formula: String - The range used to fill the control.
        isR1C1: boolean - Whether the formula needs to be formatted as R1C1.
        isLocal: boolean - Whether the formula needs to be formatted by locale.
      • updateSelectedValue

         updateSelectedValue()
        Update the selected value by the value of the linked cell.
      • calculateTextSize

        int[] calculateTextSize()
        Recalculate the text area
        Returns:
        Text's Size in an array(width and height).
      • formatCharacters

         formatCharacters(startIndex, length, font, flag)
        Formats some characters with the font setting.
        Parameters:
        startIndex: int - The start index.
        length: int - The length.
        font: Font - The font setting.
        flag: StyleFlag - The flag of the font setting.
      • characters

        FontSetting characters(startIndex, length)
        Returns a Characters object that represents a range of characters within the text. This method only works on shape with title.
        Parameters:
        startIndex: int - The index of the start of the character.
        length: int - The number of characters.
        Returns:
        Characters object.
      • getCharacters

        ArrayList getCharacters()
        Returns all Characters objects that represents a range of characters within the text . NOTE: This method is now obsolete. Instead, please use Shape.GetRichFormattings() method. This method will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.
        Returns:
        All Characters objects
      • getRichFormattings

        FontSetting[] getRichFormattings()
        Returns all Characters objects that represents a range of characters within the text .
        Returns:
        All Characters objects
      • removeActiveXControl

         removeActiveXControl()
        Remove activeX control.
      • getActualBox

        float[] getActualBox()
        Get the actual position and size of the shape (after applying rotation, flip, etc.) Note:The interface is not fully functional, especially the location information is not correct.It is recommended not to use this interface until the function is complete.
        Returns:
        Return the position and size in the order of x, y, w, h
      • getConnectionPoints

        float[][] getConnectionPoints()
        Get the connection points
        Returns:
        [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.
      • toImage

         toImage(imageFile, options)
        Saves the shape to a file.
      • getResultOfSmartArt

        GroupShape getResultOfSmartArt()
        Converting smart art to grouped shapes.
      • toFrontOrBack

         toFrontOrBack(orders)
        Brings the shape to the front or sends the shape to back.
        Parameters:
        orders: int - If it's less than zero, sets the shape to back. If it's greater than zero, brings the shape to front.
      • getLockedProperty

        boolean getLockedProperty(type)
        Gets the value of locked property.
        Parameters:
        type: int - A ShapeLockType value. The type of the shape locked property.
        Returns:
        Returns the value of locked property.
      • setLockedProperty

         setLockedProperty(type, value)
        Set the locked property.
        Parameters:
        type: int - A ShapeLockType value. The locked type.
        value: boolean - The value of the property.
      • addHyperlink

        Hyperlink addHyperlink(address)
        Adds a hyperlink to the shape.
        Parameters:
        address: String - Address of the hyperlink.
        Returns:
        Return the new hyperlink object.
      • removeHyperlink

         removeHyperlink()
        Removes the hyperlink of the shape.
      • moveToRange

         moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)
        Moves the shape to a specified range.
        Parameters:
        upperLeftRow: int - Upper left row index.
        upperLeftColumn: int - Upper left column index.
        lowerRightRow: int - Lower right row index
        lowerRightColumn: int - Lower right column index
      • alignTopRightCorner

         alignTopRightCorner(topRow, rightColumn)
        Moves the picture to the top-right corner.
        Parameters:
        topRow: int - the row index.
        rightColumn: int - the column index.