asposecells.api
Class Oval

Represents the oval shape.

Property Getters/Setters Summary
methodgetActualLowerRightRow()
           Get the actual bottom row.
methodgetAlternativeText()
methodsetAlternativeText(value)
           Returns or sets the descriptive (alternative) text string of the Shape object.
methodgetAutoShapeType()
methodsetAutoShapeType(value)
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
methodgetBottom()
methodsetBottom(value)
           Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
methodgetConnectionPoints()
           Get the connection points
methodgetControlData()
           Gets the data of control.
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()
methodsetFont(value)
           Represents the font of shape.
methodgetFormat()
           Represents the setting of the shape's formatting.
methodgetFormatPicture()
           Gets and sets the options of the picture format.
methodgetGeometry()
           Gets the geometry
methodgetGlow()
           Represents a object that specifies glow effect for the chart element or shape.
methodgetGroup()
           Gets the group shape which contains this shape.
methodhasLine()
methodsetHasLine(value)
           Gets and sets the line border of the shape is visible.
methodgetHeight()
methodsetHeight(value)
           Represents the height of shape, in unit of pixel.
methodgetHeightCM()
methodsetHeightCM(value)
           Represents the height of the shape, in unit of inches.
methodgetHeightInch()
methodsetHeightInch(value)
           Represents the height of the shape, in unit of inches.
methodgetHeightInChart()
methodsetHeightInChart(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..
methodgetHeightInShape()
methodsetHeightInShape(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..
methodgetHeightPt()
methodsetHeightPt(value)
           Represents the height of the shape, in unit of points.
methodgetHeightScale()
methodsetHeightScale(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;
methodgetHtmlText()
methodsetHtmlText(value)
           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.
methodgetInputRange()
methodsetInputRange(value)
           Gets or sets the worksheet range used to fill the specified combo box.
methodisEquation()
           Inidicates whether the shape only contains an equation.
methodisFilled()
methodsetFilled(value)
           Indicates whether the fill format is visible.
methodisFlippedHorizontally()
methodsetFlippedHorizontally(value)
           Gets and sets whether shape is horizontally flipped .
methodisFlippedVertically()
methodsetFlippedVertically(value)
           Gets and sets whether shape is vertically flipped .
methodisGroup()
           Indicates whether the shape is a group.
methodisHidden()
methodsetHidden(value)
           Indicates whether the object is visible.
methodisLockAspectRatio()
methodsetLockAspectRatio(value)
           True means that don't allow changes in aspect ratio.
methodisLocked()
methodsetLocked(value)
           True if the object is locked, False if the object can be modified when the sheet is protected.
methodisPrintable()
methodsetPrintable(value)
           True if the object is printable
methodisRichText()
           Whether or not the text is rich text.
methodisSmartArt()
           Inidicates whether the shape is smart art.
methodisTextWrapped()
methodsetTextWrapped(value)
           Gets and sets the text wrapped type of the shape which contains text.
methodisWordArt()
           Indicates whether this shape is a word art.
methodgetLeft()
methodsetLeft(value)
           Represents the horizontal offset of shape from its left column, in unit of pixels.
methodgetLeftCM()
methodsetLeftCM(value)
           Represents the horizontal offset of shape from its left column, in unit of centimeters.
methodgetLeftInch()
methodsetLeftInch(value)
           Represents the horizontal offset of shape from its left column, in unit of inches.
methodgetLeftInChart()
methodsetLeftInChart(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.
methodgetLeftInShape()
methodsetLeftInShape(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.
methodgetLeftToCorner()
methodsetLeftToCorner(value)
           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()
methodsetLinkedCell(value)
           Gets or sets the worksheet range linked to the control's value.
methodgetLowerDeltaX()
methodsetLowerDeltaX(value)
           Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.
methodgetLowerDeltaY()
methodsetLowerDeltaY(value)
           Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.
methodgetLowerRightColumn()
methodsetLowerRightColumn(value)
           Represents lower right corner column index.
methodgetLowerRightRow()
methodsetLowerRightRow(value)
           Represents lower right corner row index.
methodgetMacroName()
methodsetMacroName(value)
           Gets and sets the name of macro.
methodgetMsoDrawingType()
           Gets and sets mso drawing type. The value of the property is MsoDrawingType integer constant.
methodgetName()
methodsetName(value)
           Gets and sets the name of the shape.
methodgetPaths()
           Gets the paths of a custom geometric shape.
methodgetPlacement()
methodsetPlacement(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.
methodgetPositionX()
methodsetPositionX(value)
           Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
methodgetPositionY()
methodsetPositionY(value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
methodgetReflection()
           Represents a object that specifies reflection effect for the chart element or shape.
methodgetRelativeToOriginalPictureSize()
methodsetRelativeToOriginalPictureSize(value)
           Indicates whether shape is relative to original picture size.
methodgetRight()
methodsetRight(value)
           Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
methodgetRotationAngle()
methodsetRotationAngle(value)
           Gets and sets the rotation of the shape.
methodgetShadowEffect()
           Represents a object that specifies shadow effect for the chart element or shape.
methodgetSoftEdges()
methodsetSoftEdges(value)
           Gets and sets the radius of blur to apply to the edges, in unit of points.
methodgetSpid()
           Specifies an optional string 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()
methodsetText(value)
           Represents the string in this TextBox object.
methodgetTextBody()
           Gets and ses the setting of the shape's text.
methodgetTextDirection()
methodsetTextDirection(value)
           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.
methodgetTextFrame()
           Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
methodgetTextHorizontalAlignment()
methodsetTextHorizontalAlignment(value)
           Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
methodgetTextHorizontalOverflow()
methodsetTextHorizontalOverflow(value)
           Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
methodgetTextOptions()
           Represents the text options of the shape.
methodgetTextOrientationType()
methodsetTextOrientationType(value)
           Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
methodgetTextShapeType()
methodsetTextShapeType(value)
           Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
methodgetTextVerticalAlignment()
methodsetTextVerticalAlignment(value)
           Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
methodgetTextVerticalOverflow()
methodsetTextVerticalOverflow(value)
           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()
methodsetTitle(value)
           Specifies the title (caption) of the current shape object.
methodgetTop()
methodsetTop(value)
           Represents the vertical offset of shape from its top row, in unit of pixels.
methodgetTopCM()
methodsetTopCM(value)
           Represents the vertical offset of shape from its top row, in unit of centimeters.
methodgetTopInch()
methodsetTopInch(value)
           Represents the vertical offset of shape from its top row, in unit of inches.
methodgetTopInChart()
methodsetTopInChart(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.
methodgetTopInShape()
methodsetTopInShape(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.
methodgetTopToCorner()
methodsetTopToCorner(value)
           Gets and sets the vertical offset of shape from worksheet top boder,in unit of pixel
methodgetType()
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
methodgetUpperDeltaX()
methodsetUpperDeltaX(value)
           Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.
methodgetUpperDeltaY()
methodsetUpperDeltaY(value)
           Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.
methodgetUpperLeftColumn()
methodsetUpperLeftColumn(value)
           Represents upper left corner column index.
methodgetUpperLeftRow()
methodsetUpperLeftRow(value)
           Represents upper left corner row index.
methodgetWidth()
methodsetWidth(value)
           Represents the width of shape, in unit of pixels.
methodgetWidthCM()
methodsetWidthCM(value)
           Represents the width of the shape, in unit of centimeters.
methodgetWidthInch()
methodsetWidthInch(value)
           Represents the width of the shape, in unit of inch.
methodgetWidthInChart()
methodsetWidthInChart(value)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
methodgetWidthInShape()
methodsetWidthInShape(value)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
methodgetWidthPt()
methodsetWidthPt(value)
           Represents the width of the shape, in unit of point.
methodgetWidthScale()
methodsetWidthScale(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;
methodgetX()
methodsetX(value)
           Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
methodgetY()
methodsetY(value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
methodgetZOrderPosition()
methodsetZOrderPosition(value)
           Returns the position of a shape in the z-order.
 
Method Summary
methodaddHyperlink(address)→ inherited from Shape
           Adds a hyperlink to the shape.
methodalignTopRightCorner(topRow, rightColumn)→ inherited from Shape
           Moves the picture to the top-right corner.
methodcalculateTextSize()→ inherited from Shape
           Recalculate the text area
methodcharacters(startIndex, length)→ inherited from Shape
           Returns a Characters object that represents a range of characters within the text.
methodformatCharacters(startIndex, length, font)→ inherited from Shape
           Format some chararcters with the font setting.
methodformatCharacters(startIndex, length, font, flag)→ inherited from Shape
           Format some chararcters with the font setting.
methodgetCharacters()→ inherited from Shape
           Returns all Characters objects that represents a range of characters within the text .
methodgetInputRange(isR1C1, isLocal)→ inherited from Shape
           Gets the range used to fill the control.
methodgetLinkedCell(isR1C1, isLocal)→ inherited from Shape
           Gets the range linked to the control's value.
methodgetLockedProperty(type)→ inherited from Shape
           Gets the value of locked property.
methodgetResultOfSmartArt()→ inherited from Shape
           Converting smart art to grouped shapes.
methodmoveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)→ inherited from Shape
           Moves the shape to a specified range.
methodremoveHyperlink()→ inherited from Shape
           Remove the hyperlink of the shape.
methodsetInputRange(formula, isR1C1, isLocal)→ inherited from Shape
           Sets the range used to fill the control.
methodsetLinkedCell(formula, isR1C1, isLocal)→ inherited from Shape
           Sets the range linked to the control's value.
methodsetLockedProperty(type, value)→ inherited from Shape
           Set the locked property.
methodtoFrontOrBack(orders)→ inherited from Shape
           Brings the shape to the front or sends the shape to back.
methodtoImage(imageFile, options)→ inherited from Shape
           Saves the shape to a file.
methodupdateSelectedValue()→ inherited from Shape
           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()
Inidicates whether the shape only contains an equation.

isSmartArt : boolean 

boolean isSmartArt()
Inidicates whether the shape is 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.

getFormat : ShapeFormat 

ShapeFormat getFormat()
Represents the setting of the shape's formatting. NOTE: This member is now obsolete. Instead, please use Shape.Fill and Shape.Line properties. This property will be removed 6 months later since August 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 object that specifies shadow effect for the chart element or shape.
See Also:
ShadowEffect

getReflection : ReflectionEffect 

ReflectionEffect getReflection()
Represents a object that specifies reflection effect for the chart element or shape.
See Also:
ReflectionEffect

getGlow : GlowEffect 

GlowEffect getGlow()
Represents a object that specifies glow effect for the chart element or shape.
See Also:
GlowEffect

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.

getTextFrame : MsoTextFrame 

MsoTextFrame getTextFrame()
Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.TextBody.TextAlignment property. This property will be removed 12 months later since May 2016. Aspose apologizes for any inconvenience you may have experienced.

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 don't allow changes in aspect ratio.

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 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 the shape is a group.

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 if the object is locked, False if the object can be modified when the sheet is protected.

isPrintable/setPrintable : boolean 

boolean isPrintable() / setPrintable(value)
True if the object is printable

getMsoDrawingType : int 

int getMsoDrawingType()
Gets and sets mso drawing type. The value of the property is MsoDrawingType integer constant.

getAutoShapeType/setAutoShapeType : int 

int getAutoShapeType() / setAutoShapeType(value)
Gets the auto shape type. The value of the property is AutoShapeType 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 upper left corner 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 inches.

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 boder,in unit of pixel

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.

getHeightInChart/setHeightInChart : int 

int getHeightInChart() / setHeightInChart(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 : int 

int getLeftInChart() / setLeftInChart(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 : int 

int getTopInChart() / setTopInChart(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 : int 

int getWidthInChart() / setWidthInChart(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 : int 

int getPositionX() / setPositionX(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 : int 

int getPositionY() / setPositionY(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.

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.

getConnectionPoints : Float[] 

Float[] getConnectionPoints()
Get the connection points
Returns:

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 ses the setting of the shape's text.

getFont/setFont : Font 

Font getFont() / setFont(value)
Represents the font of shape.

getTextOptions : TextOptions 

TextOptions getTextOptions()
Represents the text options of the shape.

getText/setText : String 

String getText() / setText(value)
Represents the string in this TextBox object.

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

Method Detail

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)
Format some chararcters with the font setting.
Parameters:
startIndex: int - The start index.
length: int - The the length.
font: Font - The font setting.
flag: StyleFlag - The flag of the font setting.

formatCharacters

 formatCharacters(startIndex, length, font)
Format some chararcters with the font setting. NOTE: This member is now obsolete. Instead, please use Shape.FormatCharacters(int startIndex, int length, Font font,StyleFlag flag) method. This property will be removed 12 months later since March 2016. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
startIndex: int - The start index.
length: int - The the length.
font: Font - 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 .
Returns:
All Characters objects

toImage

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

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.

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, sens 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()
Remove 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.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.