aspose.cells

Classes

Constants

Class Button

Represents the Forms control: Button

Example:

//Create a new Workbook
$workbook = new cells\Workbook();
//Get the first worksheet in the workbook
$sheet = $workbook->getWorksheets()->get(0);
//Add a new button to the worksheet
$button = $sheet->getShapes()->addShape(cells\MsoDrawingType::BUTTON, 2, 0, 2, 0, 28, 80);
//Set the caption of the button
$button->setText("Aspose");
//Set the Placement Type, the way the
//button is attached to the cells
$button->setPlacement(cells\PlacementType::FREE_FLOATING);
//Set the font name
$button->getFont()->setName("Tahoma");
//Set the caption string bold
$button->getFont()->setBold(true);
//Set the color to blue
$button->getFont()->setColor(cells\Color::getBlue());
//Set the hyperlink for the button
$button->addHyperlink("http://www.aspose.com/");

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

Method Summary
`function`	`addHyperlink(address)`
`function`	Adds a hyperlink to the shape.
`function`	`alignTopRightCorner(topRow, rightColumn)`
`function`	Moves the picture to the top-right corner.
`function`	`calculateTextSize()`
`function`	Recalculate the text area
`function`	`characters(startIndex, length)`
`function`	Returns a Characters object that represents a range of characters within the text.
`function`	`formatCharacters(startIndex, length, font, flag)`
`function`	Formats some characters with the font setting.
`function`	`getActualBox()`
`function`	Get the actual position and size of the shape (after applying rotation, flip, etc.)
`function`	`getCharacters()`
`function`	Returns all Characters objects that represents a range of characters within the text .
`function`	`getConnectionPoints()`
`function`	Get the connection points
`function`	`getInputRange(isR1C1, isLocal)`
`function`	Gets the range used to fill the control.
`function`	`getLinkedCell(isR1C1, isLocal)`
`function`	Gets the range linked to the control's value.
`function`	`getLockedProperty(type)`
`function`	Gets the value of locked property.
`function`	`getResultOfSmartArt()`
`function`	Converting smart art to grouped shapes.
`function`	`getRichFormattings()`
`function`	Returns all Characters objects that represents a range of characters within the text .
`function`	`isSameSetting(obj)`
`function`	Returns whether the shape is same.
`function`	`moveToRange(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)`
`function`	Moves the shape to a specified range.
`function`	`removeActiveXControl()`
`function`	Remove activeX control.
`function`	`removeHyperlink()`
`function`	Removes the hyperlink of the shape.
`function`	`setInputRange(formula, isR1C1, isLocal)`
`function`	Sets the range used to fill the control.
`function`	`setLinkedCell(formula, isR1C1, isLocal)`
`function`	Sets the range linked to the control's value.
`function`	`setLockedProperty(type, value)`
`function`	Set the locked property.
`function`	`toFrontOrBack(orders)`
`function`	Brings the shape to the front or sends the shape to back.
`function`	`toImage(imageFile, options)`
`function`	Saves the shape to a file.
`function`	`updateSelectedValue()`
`function`	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()
```
    Indicates whether the shape only contains an equation.
  - isSmartArt : boolean
```
function isSmartArt()
```
    Indicates whether the shape is a 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.
  - 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 ShadowEffect object that specifies shadow effect for the chart element or shape.
  - getReflection : ReflectionEffect
```
function getReflection()
```
    Represents a ReflectionEffect object that specifies reflection effect for the chart element or shape.
  - getGlow : GlowEffect
```
function getGlow()
```
    Represents a GlowEffect object that specifies glow effect for the chart element or shape.
  - 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.
  - 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 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
```
function isAspectRatioLocked() / function setAspectRatioLocked(value)
```
    True means that aspect ratio of the shape is locked.
    Only for pictures and Ole Objects.
  - 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 identifier 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.
  - getWorksheet : Worksheet
```
function getWorksheet()
```
    Gets the Worksheet object which contains this shape.
  - isGroup : boolean
```
function isGroup()
```
    Indicates whether this shape is a group shape.
  - isInGroup : boolean
```
function isInGroup()
```
    Indicates whether the shape is grouped.
  - 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 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
```
function isPrintable() / function setPrintable(value)
```
    Indicates whether the object is printable. If False, this shape will not be printed when printing.
  - getMsoDrawingType : Number
```
function getMsoDrawingType()
```
    Gets drawing type. The value of the property is MsoDrawingType integer constant.
  - getAutoShapeType/setAutoShapeType : Number
```
function getAutoShapeType() / function setAutoShapeType(value)
```
    Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
  - getAnchorType/setAnchorType : Number
```
function getAnchorType() / function setAnchorType(value)
```
    Gets and set the type of the shape anchor placeholder. The value of the property is ShapeAnchorType 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 the top 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 centimeters.
  - 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 border, in unit of pixels.
  - 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.
  - 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.
  - 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 sets the setting of the shape's text.
  - getFont/setFont : Font
```
function getFont() / function setFont(value)
```
    Represents the font of shape.
  - getTextOptions/setTextOptions : TextOptions
```
function getTextOptions() / function setTextOptions(value)
```
    Represents the text options of the shape.
  - getText/setText : String
```
function getText() / function setText(value)
```
    Gets and sets the text of this shape.
  - 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.
  - getPaths : ShapePathCollection
```
function getPaths()
```
    Gets the paths of a custom geometric shape.
  - getGeometry : Geometry
```
function getGeometry()
```
    Gets the geometry
  - getCreateId/setCreateId : UUID
```
function getCreateId() / function setCreateId(value)
```
    Gets and sets create id for this shape.
- Method Detail
  - 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.
  - 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)
```
    Formats some characters with the font setting.
    Parameters:
    startIndex: Number - The start index.
    length: Number - The length.
    font: Font - The font setting.
    flag: StyleFlag - The flag of 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 .
    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
```
function getRichFormattings()
```
    Returns all Characters objects that represents a range of characters within the text .
    Returns:
    All Characters objects
  - removeActiveXControl
```
function removeActiveXControl()
```
    Remove activeX control.
  - isSameSetting
```
function isSameSetting(obj)
```
    Returns whether the shape is same.
    Parameters:
    obj: Object -
    Returns:
  - getActualBox
```
function 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
```
function 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
```
function toImage(imageFile, options)
```
    Saves the shape to a file.
  - getResultOfSmartArt
```
function getResultOfSmartArt()
```
    Converting smart art to grouped shapes.
  - 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, sets 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()
```
    Removes 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.

aspose.cells

Classes

Constants

Class Button

Property Getters/Setters Detail

getMacroName/setMacroName : String

isEquation : boolean

isSmartArt : boolean

getZOrderPosition/setZOrderPosition : Number

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 : Number

getThreeDFormat : ThreeDFormat

getFormatPicture : MsoFormatPicture

isHidden/setHidden : boolean

isLockAspectRatio/setLockAspectRatio : boolean

isAspectRatioLocked/setAspectRatioLocked : boolean

getRotationAngle/setRotationAngle : Number

getHyperlink : Hyperlink

getId : Number

getSpid : String

getSpt : Number

getWorksheet : Worksheet

isGroup : boolean

isInGroup : boolean

isWordArt : boolean

getTextEffect : TextEffectFormat

isLocked/setLocked : boolean

isPrintable/setPrintable : boolean

getMsoDrawingType : Number

getAutoShapeType/setAutoShapeType : Number

getAnchorType/setAnchorType : Number

getPlacement/setPlacement : Number

getUpperLeftRow/setUpperLeftRow : Number

getUpperDeltaY/setUpperDeltaY : Number

getUpperLeftColumn/setUpperLeftColumn : Number

getUpperDeltaX/setUpperDeltaX : Number

getLowerRightRow/setLowerRightRow : Number

getLowerDeltaY/setLowerDeltaY : Number

getLowerRightColumn/setLowerRightColumn : Number

getLowerDeltaX/setLowerDeltaX : Number

getRight/setRight : Number

getBottom/setBottom : Number

getWidth/setWidth : Number

getWidthInch/setWidthInch : Number

getWidthPt/setWidthPt : Number

getWidthCM/setWidthCM : Number

getHeight/setHeight : Number

getHeightInch/setHeightInch : Number

getHeightPt/setHeightPt : Number

getHeightCM/setHeightCM : Number

getLeft/setLeft : Number

getLeftInch/setLeftInch : Number

getLeftCM/setLeftCM : Number

getTop/setTop : Number

getTopInch/setTopInch : Number

getTopCM/setTopCM : Number

getTopToCorner/setTopToCorner : Number

getLeftToCorner/setLeftToCorner : Number

getX/setX : Number

getY/setY : Number

getWidthScale/setWidthScale : Number

getHeightScale/setHeightScale : Number

getTopInShape/setTopInShape : Number

getLeftInShape/setLeftInShape : Number

getWidthInShape/setWidthInShape : Number

getHeightInShape/setHeightInShape : Number

getGroup : GroupShape

getType : Number

hasLine/setHasLine : boolean

isFilled/setFilled : boolean

isFlippedHorizontally/setFlippedHorizontally : boolean