asposecells.api

Classes

Constants

Class Label

Encapsulates the object that represents a label in a spreadsheet.

Example:

# Create a new Workbook.
workbook = Workbook()
# Get the first worksheet in the workbook.
sheet = workbook.getWorksheets().get(0)
# Add a new label to the worksheet.
label = sheet.getShapes().addShape(MsoDrawingType.LABEL, 2, 0, 2, 0, 60, 120)
# Set the caption of the label.
label.setText("This is a Label")
# Set the Placement Type, the way the
# label is attached to the cells.
label.setPlacement(PlacementType.FREE_FLOATING)
# Set the fill color of the label.
label.getFillFormat().setForeColor(Color.getYellow())
# Saves the file.
workbook.save("Book1.xls")

Property Getters/Setters Summary
`method`	`getActualLowerRightRow()`
	Get the actual bottom row.
`method`	`getAlternativeText()`
`method`	`setAlternativeText(value)`
	Returns or sets the descriptive (alternative) text string of the Shape object.
`method`	`getAnchorType()`
`method`	`setAnchorType(value)`
	Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
`method`	`getAutoShapeType()`
`method`	`setAutoShapeType(value)`
	Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
`method`	`getBottom()`
`method`	`setBottom(value)`
	Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
`method`	`getControlData()`
	Gets the data of control.
`method`	`getCreateId()`
`method`	`setCreateId(value)`
	Gets and sets create id for this shape.
`method`	`getFill()`
	Returns a FillFormat object that contains fill formatting properties for the specified shape.
`method`	`getFillFormat()`
	Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
`method`	`getFont()`
`method`	`setFont(value)`
	Represents the font of shape.
`method`	`getFormatPicture()`
	Gets and sets the options of the picture format.
`method`	`getGeometry()`
	Gets the geometry
`method`	`getGlow()`
	Represents a GlowEffect object that specifies glow effect for the chart element or shape.
`method`	`getGroup()`
	Gets the group shape which contains this shape.
`method`	`hasLine()`
`method`	`setHasLine(value)`
	Gets and sets the line border of the shape is visible.
`method`	`getHeight()`
`method`	`setHeight(value)`
	Represents the height of shape, in unit of pixel.
`method`	`getHeightCM()`
`method`	`setHeightCM(value)`
	Represents the height of the shape, in unit of centimeters.
`method`	`getHeightInch()`
`method`	`setHeightInch(value)`
	Represents the height of the shape, in unit of inches.
`method`	`getHeightInShape()`
`method`	`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..
`method`	`getHeightPt()`
`method`	`setHeightPt(value)`
	Represents the height of the shape, in unit of points.
`method`	`getHeightScale()`
`method`	`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;
`method`	`getHtmlText()`
`method`	`setHtmlText(value)`
	Gets and sets the html string which contains data and some formats in this textbox.
`method`	`getHyperlink()`
	Gets the hyperlink of the shape.
`method`	`getId()`
	Gets the identifier of this shape.
`method`	`getInputRange()`
`method`	`setInputRange(value)`
	Gets or sets the worksheet range used to fill the specified combo box.
`method`	`isAspectRatioLocked()`
`method`	`setAspectRatioLocked(value)`
	True means that aspect ratio of the shape is locked.
`method`	`isEquation()`
	Indicates whether the shape only contains an equation.
`method`	`isFilled()`
`method`	`setFilled(value)`
	Indicates whether the fill format is visible.
`method`	`isFlippedHorizontally()`
`method`	`setFlippedHorizontally(value)`
	Gets and sets whether shape is horizontally flipped .
`method`	`isFlippedVertically()`
`method`	`setFlippedVertically(value)`
	Gets and sets whether shape is vertically flipped .
`method`	`isGroup()`
	Indicates whether this shape is a group shape.
`method`	`isHidden()`
`method`	`setHidden(value)`
	Indicates whether the object is visible.
`method`	`isInGroup()`
	Indicates whether the shape is grouped.
`method`	`isLockAspectRatio()`
`method`	`setLockAspectRatio(value)`
	True means that aspect ratio of the shape is locked.
`method`	`isLocked()`
`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.
`method`	`isPrintable()`
`method`	`setPrintable(value)`
	Indicates whether the object is printable. If False, this shape will not be printed when printing.
`method`	`isRichText()`
	Whether or not the text is rich text.
`method`	`isSmartArt()`
	Indicates whether the shape is a smart art.
`method`	`isTextWrapped()`
`method`	`setTextWrapped(value)`
	Gets and sets the text wrapped type of the shape which contains text.
`method`	`isWordArt()`
	Indicates whether this shape is a word art.
`method`	`getLeft()`
`method`	`setLeft(value)`
	Represents the horizontal offset of shape from its left column, in unit of pixels.
`method`	`getLeftCM()`
`method`	`setLeftCM(value)`
	Represents the horizontal offset of shape from its left column, in unit of centimeters.
`method`	`getLeftInch()`
`method`	`setLeftInch(value)`
	Represents the horizontal offset of shape from its left column, in unit of inches.
`method`	`getLeftInShape()`
`method`	`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.
`method`	`getLeftToCorner()`
`method`	`setLeftToCorner(value)`
	Gets and sets the horizonal offset of shape from worksheet left border.
`method`	`getLine()`
	Gets line style
`method`	`getLineFormat()`
	Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
`method`	`getLinkedCell()`
`method`	`setLinkedCell(value)`
	Gets or sets the worksheet range linked to the control's value.
`method`	`getLowerDeltaX()`
`method`	`setLowerDeltaX(value)`
	Gets or sets the shape's horizontal offset from its lower right corner column.
`method`	`getLowerDeltaY()`
`method`	`setLowerDeltaY(value)`
	Gets or sets the shape's vertical offset from its lower right corner row.
`method`	`getLowerRightColumn()`
`method`	`setLowerRightColumn(value)`
	Represents lower right corner column index.
`method`	`getLowerRightRow()`
`method`	`setLowerRightRow(value)`
	Represents lower right corner row index.
`method`	`getMacroName()`
`method`	`setMacroName(value)`
	Gets and sets the name of macro.
`method`	`getMsoDrawingType()`
	Gets drawing type. The value of the property is MsoDrawingType integer constant.
`method`	`getName()`
`method`	`setName(value)`
	Gets and sets the name of the shape.
`method`	`getPaths()`
	Gets the paths of a custom geometric shape.
`method`	`getPlacement()`
`method`	`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.
`method`	`getReflection()`
	Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
`method`	`getRelativeToOriginalPictureSize()`
`method`	`setRelativeToOriginalPictureSize(value)`
	Indicates whether shape is relative to original picture size.
`method`	`getRight()`
`method`	`setRight(value)`
	Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
`method`	`getRotationAngle()`
`method`	`setRotationAngle(value)`
	Gets and sets the rotation of the shape.
`method`	`getShadowEffect()`
	Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
`method`	`getSoftEdges()`
`method`	`setSoftEdges(value)`
	Gets and sets the radius of blur to apply to the edges, in unit of points.
`method`	`getSpid()`
	Specifies an optional string identifier that an application can use to identify the particular shape.
`method`	`getSpt()`
	Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
`method`	`getText()`
`method`	`setText(value)`
	Gets and sets the text of this shape.
`method`	`getTextBody()`
	Gets and sets the setting of the shape's text.
`method`	`getTextDirection()`
`method`	`setTextDirection(value)`
	Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
`method`	`getTextEffect()`
	Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
`method`	`getTextHorizontalAlignment()`
`method`	`setTextHorizontalAlignment(value)`
	Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
`method`	`getTextHorizontalOverflow()`
`method`	`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.
`method`	`getTextOptions()`
`method`	`setTextOptions(value)`
	Represents the text options of the shape.
`method`	`getTextOrientationType()`
`method`	`setTextOrientationType(value)`
	Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
`method`	`getTextShapeType()`
`method`	`setTextShapeType(value)`
	Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
`method`	`getTextVerticalAlignment()`
`method`	`setTextVerticalAlignment(value)`
	Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
`method`	`getTextVerticalOverflow()`
`method`	`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.
`method`	`getThreeDFormat()`
	Gets and sets 3d format of the shape.
`method`	`getTitle()`
`method`	`setTitle(value)`
	Specifies the title (caption) of the current shape object.
`method`	`getTop()`
`method`	`setTop(value)`
	Represents the vertical offset of shape from its top row, in unit of pixels.
`method`	`getTopCM()`
`method`	`setTopCM(value)`
	Represents the vertical offset of shape from its top row, in unit of centimeters.
`method`	`getTopInch()`
`method`	`setTopInch(value)`
	Represents the vertical offset of shape from its top row, in unit of inches.
`method`	`getTopInShape()`
`method`	`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.
`method`	`getTopToCorner()`
`method`	`setTopToCorner(value)`
	Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
`method`	`getType()`
	Gets the auto shape type. The value of the property is AutoShapeType integer constant.
`method`	`getUpperDeltaX()`
`method`	`setUpperDeltaX(value)`
	Gets or sets the shape's horizontal offset from its upper left corner column.
`method`	`getUpperDeltaY()`
`method`	`setUpperDeltaY(value)`
	Gets or sets the shape's vertical offset from its upper left corner row.
`method`	`getUpperLeftColumn()`
`method`	`setUpperLeftColumn(value)`
	Represents upper left corner column index.
`method`	`getUpperLeftRow()`
`method`	`setUpperLeftRow(value)`
	Represents the top row index.
`method`	`getWidth()`
`method`	`setWidth(value)`
	Represents the width of shape, in unit of pixels.
`method`	`getWidthCM()`
`method`	`setWidthCM(value)`
	Represents the width of the shape, in unit of centimeters.
`method`	`getWidthInch()`
`method`	`setWidthInch(value)`
	Represents the width of the shape, in unit of inch.
`method`	`getWidthInShape()`
`method`	`setWidthInShape(value)`
	Represents the width of the shape, in unit of 1/4000 of the parent shape.
`method`	`getWidthPt()`
`method`	`setWidthPt(value)`
	Represents the width of the shape, in unit of point.
`method`	`getWidthScale()`
`method`	`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;
`method`	`getWorksheet()`
	Gets the Worksheet object which contains this shape.
`method`	`getX()`
`method`	`setX(value)`
	Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
`method`	`getY()`
`method`	`setY(value)`
	Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
`method`	`getZOrderPosition()`
`method`	`setZOrderPosition(value)`
	Returns the position of a shape in the z-order.

Method Summary
`method`	`addHyperlink(address)`
`method`	Adds a hyperlink to the shape.
`method`	`alignTopRightCorner(topRow, rightColumn)`
`method`	Moves the picture to the top-right corner.
`method`	`calculateTextSize()`
`method`	Recalculate the text area
`method`	`characters(startIndex, length)`
`method`	Returns a Characters object that represents a range of characters within the text.
`method`	`formatCharacters(startIndex, length, font, flag)`
`method`	Formats some characters with the font setting.
`method`	`getActualBox()`
`method`	Get the actual position and size of the shape (after applying rotation, flip, etc.)
`method`	`getCharacters()`
`method`	Returns all Characters objects that represents a range of characters within the text .
`method`	`getConnectionPoints()`
`method`	Get the connection points
`method`	`getInputRange(isR1C1, isLocal)`
`method`	Gets the range used to fill the control.
`method`	`getLinkedCell(isR1C1, isLocal)`
`method`	Gets the range linked to the control's value.
`method`	`getLockedProperty(type)`
`method`	Gets the value of locked property.
`method`	`getResultOfSmartArt()`
`method`	Converting smart art to grouped shapes.
`method`	`getRichFormattings()`
`method`	Returns all Characters objects that represents a range of characters within the text .
`method`	`isSameSetting(obj)`
`method`	Returns whether the shape is same.
`method`	`moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)`
`method`	Moves the shape to a specified range.
`method`	`removeActiveXControl()`
`method`	Remove activeX control.
`method`	`removeHyperlink()`
`method`	Removes the hyperlink of the shape.
`method`	`setInputRange(formula, isR1C1, isLocal)`
`method`	Sets the range used to fill the control.
`method`	`setLinkedCell(formula, isR1C1, isLocal)`
`method`	Sets the range linked to the control's value.
`method`	`setLockedProperty(type, value)`
`method`	Set the locked property.
`method`	`toFrontOrBack(orders)`
`method`	Brings the shape to the front or sends the shape to back.
`method`	`toImage(imageFile, options)`
`method`	Saves the shape to a file.
`method`	`updateSelectedValue()`
`method`	Update the selected value by the value of the linked cell.

- Property Getters/Setters Detail
  - 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.
  - getLine : LineFormat
```
LineFormat getLine()
```
    Gets line style
  - getFill : FillFormat
```
FillFormat getFill()
```
    Returns a FillFormat object that contains fill formatting properties for the specified shape.
  - getShadowEffect : ShadowEffect
```
ShadowEffect getShadowEffect()
```
    Represents a ShadowEffect object that specifies shadow effect for the chart element or shape.
  - getReflection : ReflectionEffect
```
ReflectionEffect getReflection()
```
    Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
  - getGlow : GlowEffect
```
GlowEffect getGlow()
```
    Represents a GlowEffect object that specifies glow effect for the chart element or shape.
  - getSoftEdges/setSoftEdges : float
```
float getSoftEdges() / setSoftEdges(value)
```
    Gets and sets the radius of blur to apply to the edges, in unit of points.
  - getThreeDFormat : ThreeDFormat
```
ThreeDFormat getThreeDFormat()
```
    Gets and sets 3d format of the shape.
  - getFormatPicture : MsoFormatPicture
```
MsoFormatPicture getFormatPicture()
```
    Gets and sets the options of the picture format.
  - 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.
  - getHyperlink : Hyperlink
```
Hyperlink getHyperlink()
```
    Gets the hyperlink 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.
  - getWorksheet : Worksheet
```
Worksheet getWorksheet()
```
    Gets the Worksheet object which contains this shape.
  - 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.
  - getGroup : GroupShape
```
GroupShape getGroup()
```
    Gets the group shape which contains this shape.
  - 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.
  - getTextBody : FontSettingCollection
```
FontSettingCollection getTextBody()
```
    Gets and sets the setting of the shape's text.
  - 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.
  - getPaths : ShapePathCollection
```
ShapePathCollection getPaths()
```
    Gets the paths of a custom geometric shape.
  - getGeometry : Geometry
```
Geometry getGeometry()
```
    Gets the geometry
  - getCreateId/setCreateId : UUID
```
UUID getCreateId() / setCreateId(value)
```
    Gets and sets create id for this shape.
- Method Detail
  - 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.
  - isSameSetting
```
boolean isSameSetting(obj)
```
    Returns whether the shape is same.
    Parameters:
    obj: Object -
    Returns:
  - 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.

asposecells.api

Classes

Constants

Class Label

Property Getters/Setters Detail

getMacroName/setMacroName : String

isEquation : boolean

isSmartArt : boolean

getZOrderPosition/setZOrderPosition : int

getName/setName : String

getAlternativeText/setAlternativeText : String

getTitle/setTitle : String

getLineFormat : MsoLineFormat

getFillFormat : MsoFillFormat

getLine : LineFormat

getFill : FillFormat

getShadowEffect : ShadowEffect

getReflection : ReflectionEffect

getGlow : GlowEffect

getSoftEdges/setSoftEdges : float

getThreeDFormat : ThreeDFormat

getFormatPicture : MsoFormatPicture

isHidden/setHidden : boolean

isLockAspectRatio/setLockAspectRatio : boolean

isAspectRatioLocked/setAspectRatioLocked : boolean

getRotationAngle/setRotationAngle : float

getHyperlink : Hyperlink

getId : int

getSpid : String

getSpt : int

getWorksheet : Worksheet

isGroup : boolean

isInGroup : boolean

isWordArt : boolean

getTextEffect : TextEffectFormat

isLocked/setLocked : boolean

isPrintable/setPrintable : boolean

getMsoDrawingType : int

getAutoShapeType/setAutoShapeType : int

getAnchorType/setAnchorType : int

getPlacement/setPlacement : int

getUpperLeftRow/setUpperLeftRow : int

getUpperDeltaY/setUpperDeltaY : int

getUpperLeftColumn/setUpperLeftColumn : int

getUpperDeltaX/setUpperDeltaX : int

getLowerRightRow/setLowerRightRow : int

getLowerDeltaY/setLowerDeltaY : int

getLowerRightColumn/setLowerRightColumn : int

getLowerDeltaX/setLowerDeltaX : int

getRight/setRight : int

getBottom/setBottom : int

getWidth/setWidth : int

getWidthInch/setWidthInch : float

getWidthPt/setWidthPt : float

getWidthCM/setWidthCM : float

getHeight/setHeight : int

getHeightInch/setHeightInch : float

getHeightPt/setHeightPt : float

getHeightCM/setHeightCM : float

getLeft/setLeft : int

getLeftInch/setLeftInch : float

getLeftCM/setLeftCM : float

getTop/setTop : int

getTopInch/setTopInch : float

getTopCM/setTopCM : float

getTopToCorner/setTopToCorner : int

getLeftToCorner/setLeftToCorner : int

getX/setX : int

getY/setY : int

getWidthScale/setWidthScale : int

getHeightScale/setHeightScale : int

getTopInShape/setTopInShape : int

getLeftInShape/setLeftInShape : int

getWidthInShape/setWidthInShape : int

getHeightInShape/setHeightInShape : int

getGroup : GroupShape

getType : int

hasLine/setHasLine : boolean

isFilled/setFilled : boolean

isFlippedHorizontally/setFlippedHorizontally : boolean