aspose.cells
Class SmartArtShape

Represents the smart art.

Property Getters/Setters Summary
functiongetActiveXControl()
           Gets the ActiveX control.
functiongetActualLowerRightRow()
           Get the actual bottom row.
functiongetAlternativeText()
functionsetAlternativeText(value)
           Returns or sets the descriptive (alternative) text string of the Shape object.
functiongetAutoShapeType()
functionsetAutoShapeType(value)
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
functiongetBottom()
functionsetBottom(value)
           Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
functiongetConnectionPoints()
           Get the connection points
functiongetControlData()
           Gets the data of control.
functiongetFill()
           Returns a FillFormat object that contains fill formatting properties for the specified shape.
functiongetFillFormat()
           Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
functiongetFont()
functionsetFont(value)
           Represents the font of shape.
functiongetFormat()
           Represents the setting of the shape's formatting.
functiongetFormatPicture()
           Gets and sets the options of the picture format.
functiongetGeometry()
           Gets the geometry
functiongetGlow()
           Represents a object that specifies glow effect for the chart element or shape.
functiongetGroup()
           Gets the group shape which contains this shape.
functionhasLine()
functionsetHasLine(value)
           Gets and sets the line border of the shape is visible.
functiongetHeight()
functionsetHeight(value)
           Represents the height of shape, in unit of pixel.
functiongetHeightCM()
functionsetHeightCM(value)
           Represents the height of the shape, in unit of inches.
functiongetHeightInch()
functionsetHeightInch(value)
           Represents the height of the shape, in unit of inches.
functiongetHeightInChart()
functionsetHeightInChart(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..
functiongetHeightInShape()
functionsetHeightInShape(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..
functiongetHeightPt()
functionsetHeightPt(value)
           Represents the height of the shape, in unit of points.
functiongetHeightScale()
functionsetHeightScale(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;
functiongetHtmlText()
functionsetHtmlText(value)
           Gets and sets the html string which contains data and some formats in this textbox.
functiongetHyperlink()
           Gets the hyperlink of the shape.
functiongetId()
           Gets the identifier of this shape.
functiongetInputRange()
functionsetInputRange(value)
           Gets or sets the worksheet range used to fill the specified combo box.
functionisEquation()
           Inidicates whether the shape only contains an equation.
functionisFilled()
functionsetFilled(value)
           Indicates whether the fill format is visible.
functionisFlippedHorizontally()
functionsetFlippedHorizontally(value)
           Gets and sets whether shape is horizontally flipped .
functionisFlippedVertically()
functionsetFlippedVertically(value)
           Gets and sets whether shape is vertically flipped .
functionisGroup()
           Indicates whether the shape is a group.
functionisHidden()
functionsetHidden(value)
           Indicates whether the object is visible.
functionisLockAspectRatio()
functionsetLockAspectRatio(value)
           True means that don't allow changes in aspect ratio.
functionisLocked()
functionsetLocked(value)
           True if the object is locked, False if the object can be modified when the sheet is protected.
functionisPrintable()
functionsetPrintable(value)
           True if the object is printable
functionisRichText()
           Whether or not the text is rich text.
functionisSmartArt()
           Inidicates whether the shape is smart art.
functionisTextWrapped()
functionsetTextWrapped(value)
           Gets and sets the text wrapped type of the shape which contains text.
functionisWordArt()
           Indicates whether this shape is a word art.
functiongetLeft()
functionsetLeft(value)
           Represents the horizontal offset of shape from its left column, in unit of pixels.
functiongetLeftCM()
functionsetLeftCM(value)
           Represents the horizontal offset of shape from its left column, in unit of centimeters.
functiongetLeftInch()
functionsetLeftInch(value)
           Represents the horizontal offset of shape from its left column, in unit of inches.
functiongetLeftInChart()
functionsetLeftInChart(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.
functiongetLeftInShape()
functionsetLeftInShape(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.
functiongetLeftToCorner()
functionsetLeftToCorner(value)
           Gets and sets the horizonal offset of shape from worksheet left border.
functiongetLine()
           Gets line style
functiongetLineFormat()
           Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
functiongetLinkedCell()
functionsetLinkedCell(value)
           Gets or sets the worksheet range linked to the control's value.
functiongetLowerDeltaX()
functionsetLowerDeltaX(value)
           Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.
functiongetLowerDeltaY()
functionsetLowerDeltaY(value)
           Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.
functiongetLowerRightColumn()
functionsetLowerRightColumn(value)
           Represents lower right corner column index.
functiongetLowerRightRow()
functionsetLowerRightRow(value)
           Represents lower right corner row index.
functiongetMacroName()
functionsetMacroName(value)
           Gets and sets the name of macro.
functiongetMsoDrawingType()
           Gets and sets mso drawing type. The value of the property is MsoDrawingType integer constant.
functiongetName()
functionsetName(value)
           Gets and sets the name of the shape.
functiongetPaths()
           Gets the paths of a custom geometric shape.
functiongetPlacement()
functionsetPlacement(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.
functiongetPositionX()
functionsetPositionX(value)
           Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
functiongetPositionY()
functionsetPositionY(value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
functiongetReflection()
           Represents a object that specifies reflection effect for the chart element or shape.
functiongetRelativeToOriginalPictureSize()
functionsetRelativeToOriginalPictureSize(value)
           Indicates whether shape is relative to original picture size.
functiongetRight()
functionsetRight(value)
           Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
functiongetRotationAngle()
functionsetRotationAngle(value)
           Gets and sets the rotation of the shape.
functiongetShadowEffect()
           Represents a object that specifies shadow effect for the chart element or shape.
functiongetSoftEdges()
functionsetSoftEdges(value)
           Gets and sets the radius of blur to apply to the edges, in unit of points.
functiongetSpid()
           Specifies an optional string that an application can use to Identify the particular shape.
functiongetSpt()
           Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
functiongetText()
functionsetText(value)
           Represents the string in this TextBox object.
functiongetTextBody()
           Gets and ses the setting of the shape's text.
functiongetTextDirection()
functionsetTextDirection(value)
           Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
functiongetTextEffect()
           Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
functiongetTextFrame()
           Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
functiongetTextHorizontalAlignment()
functionsetTextHorizontalAlignment(value)
           Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
functiongetTextHorizontalOverflow()
functionsetTextHorizontalOverflow(value)
           Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
functiongetTextOptions()
           Represents the text options of the shape.
functiongetTextOrientationType()
functionsetTextOrientationType(value)
           Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
functiongetTextShapeType()
functionsetTextShapeType(value)
           Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
functiongetTextVerticalAlignment()
functionsetTextVerticalAlignment(value)
           Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
functiongetTextVerticalOverflow()
functionsetTextVerticalOverflow(value)
           Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
functiongetThreeDFormat()
           Gets and sets 3d format of the shape.
functiongetTitle()
functionsetTitle(value)
           Specifies the title (caption) of the current shape object.
functiongetTop()
functionsetTop(value)
           Represents the vertical offset of shape from its top row, in unit of pixels.
functiongetTopCM()
functionsetTopCM(value)
           Represents the vertical offset of shape from its top row, in unit of centimeters.
functiongetTopInch()
functionsetTopInch(value)
           Represents the vertical offset of shape from its top row, in unit of inches.
functiongetTopInChart()
functionsetTopInChart(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.
functiongetTopInShape()
functionsetTopInShape(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.
functiongetTopToCorner()
functionsetTopToCorner(value)
           Gets and sets the vertical offset of shape from worksheet top boder,in unit of pixel
functiongetType()
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
functiongetUpperDeltaX()
functionsetUpperDeltaX(value)
           Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.
functiongetUpperDeltaY()
functionsetUpperDeltaY(value)
           Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.
functiongetUpperLeftColumn()
functionsetUpperLeftColumn(value)
           Represents upper left corner column index.
functiongetUpperLeftRow()
functionsetUpperLeftRow(value)
           Represents upper left corner row index.
functiongetWidth()
functionsetWidth(value)
           Represents the width of shape, in unit of pixels.
functiongetWidthCM()
functionsetWidthCM(value)
           Represents the width of the shape, in unit of centimeters.
functiongetWidthInch()
functionsetWidthInch(value)
           Represents the width of the shape, in unit of inch.
functiongetWidthInChart()
functionsetWidthInChart(value)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
functiongetWidthInShape()
functionsetWidthInShape(value)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
functiongetWidthPt()
functionsetWidthPt(value)
           Represents the width of the shape, in unit of point.
functiongetWidthScale()
functionsetWidthScale(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;
functiongetX()
functionsetX(value)
           Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
functiongetY()
functionsetY(value)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
functiongetZOrderPosition()
functionsetZOrderPosition(value)
           Returns the position of a shape in the z-order.
 
Method Summary
functionaddHyperlink(address)→ inherited from Shape
           Adds a hyperlink to the shape.
functionalignTopRightCorner(topRow, rightColumn)→ inherited from Shape
           Moves the picture to the top-right corner.
functioncalculateTextSize()→ inherited from Shape
           Recalculate the text area
functioncharacters(startIndex, length)→ inherited from Shape
           Returns a Characters object that represents a range of characters within the text.
functionformatCharacters(startIndex, length, font)→ inherited from Shape
           Format some chararcters with the font setting.
functionformatCharacters(startIndex, length, font, flag)→ inherited from Shape
           Format some chararcters with the font setting.
functiongetCharacters()→ inherited from Shape
           Returns all Characters objects that represents a range of characters within the text .
functiongetInputRange(isR1C1, isLocal)→ inherited from Shape
           Gets the range used to fill the control.
functiongetLinkedCell(isR1C1, isLocal)→ inherited from Shape
           Gets the range linked to the control's value.
functiongetLockedProperty(type)→ inherited from Shape
           Gets the value of locked property.
functiongetResultOfSmartArt()
           Converting smart art to grouped shapes.
functionmoveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)→ inherited from Shape
           Moves the shape to a specified range.
functionremoveHyperlink()→ inherited from Shape
           Remove the hyperlink of the shape.
functionsetInputRange(formula, isR1C1, isLocal)→ inherited from Shape
           Sets the range used to fill the control.
functionsetLinkedCell(formula, isR1C1, isLocal)→ inherited from Shape
           Sets the range linked to the control's value.
functionsetLockedProperty(type, value)→ inherited from Shape
           Set the locked property.
functiontoFrontOrBack(orders)→ inherited from Shape
           Brings the shape to the front or sends the shape to back.
functiontoImage(stream, imageFormat)→ inherited from Shape
           Creates the shape image and saves it to a stream in the specified format.
functiontoImage(stream, options)→ inherited from Shape
           Saves the shape to a stream.
functiontoImage(imageFile, options)→ inherited from Shape
           Saves the shape to a file.
functionupdateSelectedValue()→ inherited from Shape
           Update the selected value by the value of the linked cell.
 

Property Getters/Setters Detail

getMacroName/setMacroName : String 

function getMacroName() / function setMacroName(value)
Gets and sets the name of macro.

isEquation : boolean 

function isEquation()
Inidicates whether the shape only contains an equation.

isSmartArt : boolean 

function isSmartArt()
Inidicates whether the shape is smart art. Only for ooxml file.

getZOrderPosition/setZOrderPosition : Number 

function getZOrderPosition() / function setZOrderPosition(value)
Returns the position of a shape in the z-order.

getName/setName : String 

function getName() / function setName(value)
Gets and sets the name of the shape.

getAlternativeText/setAlternativeText : String 

function getAlternativeText() / function setAlternativeText(value)
Returns or sets the descriptive (alternative) text string of the Shape object.

getTitle/setTitle : String 

function getTitle() / function setTitle(value)
Specifies the title (caption) of the current shape object.

getLineFormat : MsoLineFormat 

function 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 

function 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 

function 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 

function getLine()
Gets line style

getFill : FillFormat 

function getFill()
Returns a FillFormat object that contains fill formatting properties for the specified shape.

getShadowEffect : ShadowEffect 

function getShadowEffect()
Represents a object that specifies shadow effect for the chart element or shape.
See Also:
ShadowEffect

getReflection : ReflectionEffect 

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

getGlow : GlowEffect 

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

getSoftEdges/setSoftEdges : Number 

function getSoftEdges() / function setSoftEdges(value)
Gets and sets the radius of blur to apply to the edges, in unit of points.

getThreeDFormat : ThreeDFormat 

function getThreeDFormat()
Gets and sets 3d format of the shape.

getTextFrame : MsoTextFrame 

function 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 

function getFormatPicture()
Gets and sets the options of the picture format.

isHidden/setHidden : boolean 

function isHidden() / function setHidden(value)
Indicates whether the object is visible.

isLockAspectRatio/setLockAspectRatio : boolean 

function isLockAspectRatio() / function setLockAspectRatio(value)
True means that don't allow changes in aspect ratio.

getRotationAngle/setRotationAngle : Number 

function getRotationAngle() / function setRotationAngle(value)
Gets and sets the rotation of the shape.

getHyperlink : Hyperlink 

function getHyperlink()
Gets the hyperlink of the shape.

getId : Number 

function getId()
Gets the identifier of this shape.

getSpid : String 

function getSpid()
Specifies an optional string that an application can use to Identify the particular shape.

getSpt : Number 

function getSpt()
Specifies an optional number that an application can use to associate the particular shape with a defined shape type.

isGroup : boolean 

function isGroup()
Indicates whether the shape is a group.

isWordArt : boolean 

function isWordArt()
Indicates whether this shape is a word art. Only for the Legacy Shape of xls file.

getTextEffect : TextEffectFormat 

function 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 

function isLocked() / function setLocked(value)
True if the object is locked, False if the object can be modified when the sheet is protected.

isPrintable/setPrintable : boolean 

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

getMsoDrawingType : Number 

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

getAutoShapeType/setAutoShapeType : Number 

function getAutoShapeType() / function setAutoShapeType(value)
Gets the auto shape type. The value of the property is AutoShapeType integer constant.

getPlacement/setPlacement : Number 

function getPlacement() / function 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 : Number 

function getUpperLeftRow() / function 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 : Number 

function getUpperDeltaY() / function 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 : Number 

function getUpperLeftColumn() / function setUpperLeftColumn(value)
Represents upper left corner column index.

getUpperDeltaX/setUpperDeltaX : Number 

function getUpperDeltaX() / function 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 : Number 

function getLowerRightRow() / function setLowerRightRow(value)
Represents lower right corner row index.

getLowerDeltaY/setLowerDeltaY : Number 

function getLowerDeltaY() / function 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 : Number 

function getLowerRightColumn() / function setLowerRightColumn(value)
Represents lower right corner column index.

getLowerDeltaX/setLowerDeltaX : Number 

function getLowerDeltaX() / function 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 : Number 

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

getBottom/setBottom : Number 

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

getWidth/setWidth : Number 

function getWidth() / function setWidth(value)
Represents the width of shape, in unit of pixels.

getWidthInch/setWidthInch : Number 

function getWidthInch() / function setWidthInch(value)
Represents the width of the shape, in unit of inch.

getWidthPt/setWidthPt : Number 

function getWidthPt() / function setWidthPt(value)
Represents the width of the shape, in unit of point.

getWidthCM/setWidthCM : Number 

function getWidthCM() / function setWidthCM(value)
Represents the width of the shape, in unit of centimeters.

getHeight/setHeight : Number 

function getHeight() / function setHeight(value)
Represents the height of shape, in unit of pixel.

getHeightInch/setHeightInch : Number 

function getHeightInch() / function setHeightInch(value)
Represents the height of the shape, in unit of inches.

getHeightPt/setHeightPt : Number 

function getHeightPt() / function setHeightPt(value)
Represents the height of the shape, in unit of points.

getHeightCM/setHeightCM : Number 

function getHeightCM() / function setHeightCM(value)
Represents the height of the shape, in unit of inches.

getLeft/setLeft : Number 

function getLeft() / function setLeft(value)
Represents the horizontal offset of shape from its left column, in unit of pixels.

getLeftInch/setLeftInch : Number 

function getLeftInch() / function setLeftInch(value)
Represents the horizontal offset of shape from its left column, in unit of inches.

getLeftCM/setLeftCM : Number 

function getLeftCM() / function setLeftCM(value)
Represents the horizontal offset of shape from its left column, in unit of centimeters.

getTop/setTop : Number 

function getTop() / function 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 : Number 

function getTopInch() / function setTopInch(value)
Represents the vertical offset of shape from its top row, in unit of inches.

getTopCM/setTopCM : Number 

function getTopCM() / function setTopCM(value)
Represents the vertical offset of shape from its top row, in unit of centimeters.

getTopToCorner/setTopToCorner : Number 

function getTopToCorner() / function setTopToCorner(value)
Gets and sets the vertical offset of shape from worksheet top boder,in unit of pixel

getLeftToCorner/setLeftToCorner : Number 

function getLeftToCorner() / function setLeftToCorner(value)
Gets and sets the horizonal offset of shape from worksheet left border.

getX/setX : Number 

function getX() / function setX(value)
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

getY/setY : Number 

function getY() / function setY(value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

getWidthScale/setWidthScale : Number 

function getWidthScale() / function 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 : Number 

function getHeightScale() / function 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 : Number 

function getTopInShape() / function 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 : Number 

function getLeftInShape() / function 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 : Number 

function getWidthInShape() / function 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 : Number 

function getHeightInShape() / function 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 : Number 

function getHeightInChart() / function 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 : Number 

function getLeftInChart() / function 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 : Number 

function getTopInChart() / function 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 : Number 

function getWidthInChart() / function 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 : Number 

function getPositionX() / function 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 : Number 

function getPositionY() / function 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 

function getGroup()
Gets the group shape which contains this shape.

getType : Number 

function getType()
Gets the auto shape type. The value of the property is AutoShapeType integer constant.

hasLine/setHasLine : boolean 

function hasLine() / function setHasLine(value)
Gets and sets the line border of the shape is visible.

isFilled/setFilled : boolean 

function isFilled() / function setFilled(value)
Indicates whether the fill format is visible.

isFlippedHorizontally/setFlippedHorizontally : boolean 

function isFlippedHorizontally() / function setFlippedHorizontally(value)
Gets and sets whether shape is horizontally flipped .

isFlippedVertically/setFlippedVertically : boolean 

function isFlippedVertically() / function setFlippedVertically(value)
Gets and sets whether shape is vertically flipped .

getActualLowerRightRow : Number 

function getActualLowerRightRow()
Get the actual bottom row.

getConnectionPoints : Float[] 

function getConnectionPoints()
Get the connection points
Returns:

getRelativeToOriginalPictureSize/setRelativeToOriginalPictureSize : boolean 

function getRelativeToOriginalPictureSize() / function setRelativeToOriginalPictureSize(value)
Indicates whether shape is relative to original picture size.

getLinkedCell/setLinkedCell : String 

function getLinkedCell() / function setLinkedCell(value)
Gets or sets the worksheet range linked to the control's value.

getInputRange/setInputRange : String 

function getInputRange() / function setInputRange(value)
Gets or sets the worksheet range used to fill the specified combo box.

getTextShapeType/setTextShapeType : Number 

function getTextShapeType() / function setTextShapeType(value)
Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.

getTextBody : FontSettingCollection 

function getTextBody()
Gets and ses the setting of the shape's text.

getFont/setFont : Font 

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

getTextOptions : TextOptions 

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

getText/setText : String 

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

isRichText : boolean 

function isRichText()
Whether or not the text is rich text.

getHtmlText/setHtmlText : String 

function getHtmlText() / function setHtmlText(value)
Gets and sets the html string which contains data and some formats in this textbox.

getTextVerticalOverflow/setTextVerticalOverflow : Number 

function getTextVerticalOverflow() / function 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 : Number 

function getTextHorizontalOverflow() / function 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 

function isTextWrapped() / function setTextWrapped(value)
Gets and sets the text wrapped type of the shape which contains text.

getTextOrientationType/setTextOrientationType : Number 

function getTextOrientationType() / function setTextOrientationType(value)
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

getTextHorizontalAlignment/setTextHorizontalAlignment : Number 

function getTextHorizontalAlignment() / function setTextHorizontalAlignment(value)
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

getTextVerticalAlignment/setTextVerticalAlignment : Number 

function getTextVerticalAlignment() / function setTextVerticalAlignment(value)
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

getTextDirection/setTextDirection : Number 

function getTextDirection() / function setTextDirection(value)
Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.

getControlData : byte[] 

function getControlData()
Gets the data of control.

getActiveXControl : ActiveXControl 

function getActiveXControl()
Gets the ActiveX control.

getPaths : ShapePathCollection 

function getPaths()
Gets the paths of a custom geometric shape.

getGeometry : Geometry 

function getGeometry()
Gets the geometry

Method Detail

getResultOfSmartArt

function getResultOfSmartArt()
Converting smart art to grouped shapes.

setLinkedCell

function 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

function 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

function 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

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

calculateTextSize

function calculateTextSize()
Recalculate the text area
Returns:
Text's Size in an array(width and height).

formatCharacters

function formatCharacters(startIndex, length, font, flag)
Format some chararcters with the font setting.
Parameters:
startIndex: Number - The start index.
length: Number - The the length.
font: Font - The font setting.
flag: StyleFlag - The flag of the font setting.

formatCharacters

function 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: Number - The start index.
length: Number - The the length.
font: Font - The font setting.

characters

function 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: Number - The index of the start of the character.
length: Number - The number of characters.
Returns:
Characters object.

getCharacters

function getCharacters()
Returns all Characters objects that represents a range of characters within the text .
Returns:
All Characters objects

toImage

function toImage(stream, imageFormat)
Creates the shape image and saves it to a stream in the specified format.

The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.

Parameters:
stream: OutputStream - The output stream.
imageFormat: ImageFormat - The format in which to save the image.

toImage

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

toImage

function toImage(stream, options)
Saves the shape to a stream.

getLinkedCell

function 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.

toFrontOrBack

function toFrontOrBack(orders)
Brings the shape to the front or sends the shape to back.
Parameters:
orders: Number - If it's less than zero, sens the shape to back. If it's greater than zero, brings the shape to front.

getLockedProperty

function getLockedProperty(type)
Gets the value of locked property.
Parameters:
type: Number - A ShapeLockType value. The type of the shape locked property.
Returns:
Returns the value of locked property.

setLockedProperty

function setLockedProperty(type, value)
Set the locked property.
Parameters:
type: Number - A ShapeLockType value. The locked type.
value: boolean - The value of the property.

addHyperlink

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

removeHyperlink

function removeHyperlink()
Remove the hyperlink of the shape.

moveToRange

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

alignTopRightCorner

function alignTopRightCorner(topRow, rightColumn)
Moves the picture to the top-right corner.
Parameters:
topRow: Number - the row index.
rightColumn: Number - 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.