**Inheritance:** java.lang.Object, [com.aspose.cells.Shape](../../com.aspose.cells/shape) ``` public class TextBox extends Shape ``` Encapsulates the object that represents a textbox in a spreadsheet. **Example** ``` //Instantiate a new Workbook. Workbook workbook = new Workbook(); //Get the first worksheet in the book. Worksheet worksheet = workbook.getWorksheets().get(0); //Add a new textbox to the collection. int textboxIndex = worksheet.getTextBoxes().add(2, 1, 160, 200); //Get the textbox object. TextBox textbox0 = worksheet.getTextBoxes().get(textboxIndex); //Fill the text. textbox0.setText("ASPOSE______The .NET and JAVA Component Publisher!"); //Set the textbox to adjust it according to its contents. textbox0.getTextBody().getTextAlignment().setAutoSize(true); //Set the placement. textbox0.setPlacement(PlacementType.FREE_FLOATING); //Set the font color. textbox0.getFont().setColor(Color.getBlue()); //Set the font to bold. textbox0.getFont().setBold(true); //Set the font size. textbox0.getFont().setSize(14); //Set font attribute to italic. textbox0.getFont().setItalic(true); //Add a hyperlink to the textbox. textbox0.addHyperlink("http://www.aspose.com/"); //Get the filformat of the textbox. FillFormat fillformat = textbox0.getFill(); //Set the fillcolor. fillformat.getSolidFill().setColor(Color.getSilver()); //Get the lineformat type of the textbox. LineFormat lineformat = textbox0.getLine(); //Set the line style. lineformat.setCompoundType(MsoLineStyle.THIN_THICK); //Set the line weight. lineformat.setWeight(6); //Set the dash style to squaredot. lineformat.setDashStyle(MsoLineDashStyle.SQUARE_DOT); //Add another textbox. textboxIndex = worksheet.getTextBoxes().add(15, 4, 85, 120); //Get the second textbox. TextBox textbox1 = worksheet.getTextBoxes().get(textboxIndex); //Input some text to it. textbox1.setText("This is another simple text box"); //Set the placement type as the textbox will move and //resize with cells. textbox1.setPlacement(PlacementType.MOVE_AND_SIZE); //Save the excel file. workbook.save("tsttextboxes.xlsx"); ``` ## Methods | Method | Description | | --- | --- | | [addHyperlink(String address)](#addHyperlink-java.lang.String-) | Adds a hyperlink to the shape. | | [alignTopRightCorner(int topRow, int rightColumn)](#alignTopRightCorner-int-int-) | Moves the picture to the top-right corner. | | [calculateTextSize()](#calculateTextSize--) | Recalculate the text area | | [characters(int startIndex, int length)](#characters-int-int-) | Returns a Characters object that represents a range of characters within the text. | | [equals(Object arg0)](#equals-java.lang.Object-) | | | [fitToTextSize()](#fitToTextSize--) | Recalculate a text area suitable for displaying all text content. | | [formatCharacters(int startIndex, int length, Font font, StyleFlag flag)](#formatCharacters-int-int-com.aspose.cells.Font-com.aspose.cells.StyleFlag-) | Formats some characters with the font setting. | | [getActiveXControl()](#getActiveXControl--) | Gets the ActiveX control. | | [getActualBox()](#getActualBox--) | Get the actual position and size of the shape (after applying rotation, flip, etc.) | | [getActualLowerRightRow()](#getActualLowerRightRow--) | Get the actual bottom row. | | [getAlternativeText()](#getAlternativeText--) | Returns or sets the descriptive (alternative) text string of the [Shape](../../com.aspose.cells/shape) object. | | [getAnchorType()](#getAnchorType--) | Gets the type of the shape anchor placeholder. | | [getAutoShapeType()](#getAutoShapeType--) | Gets the auto shape type. | | [getBottom()](#getBottom--) | Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels. | | [getCharacters()](#getCharacters--) | Returns all Characters objects that represents a range of characters within the text . | | [getClass()](#getClass--) | | | [getConnectionPoints()](#getConnectionPoints--) | Get the connection points | | [getControlData()](#getControlData--) | Gets the data of control. | | [getCreateId()](#getCreateId--) | Gets create id for this shape. | | [getEquationParagraph()](#getEquationParagraph--) | Gets the first math paragraph from the TextBody property of the TextBox object. | | [getEquationParagraph(int index)](#getEquationParagraph-int-) | Get the specified math paragraph from the TextBody property of the TextBox object. | | [getFill()](#getFill--) | Returns a [getFillFormat()](../../com.aspose.cells/shape\#getFillFormat--) object that contains fill formatting properties for the specified shape. | | [getFillFormat()](#getFillFormat--) | Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. | | [getFont()](#getFont--) | Represents the font of shape. | | [getFormatPicture()](#getFormatPicture--) | Gets the options of the picture format. | | [getGeometry()](#getGeometry--) | Gets the geometry | | [getGlow()](#getGlow--) | Represents a [GlowEffect](../../com.aspose.cells/gloweffect) object that specifies glow effect for the chart element or shape. | | [getGroup()](#getGroup--) | Gets the group shape which contains this shape. | | [getHeight()](#getHeight--) | Represents the height of shape, in unit of pixel. | | [getHeightCM()](#getHeightCM--) | Represents the height of the shape, in unit of centimeters. | | [getHeightInShape()](#getHeightInShape--) | 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.. | | [getHeightInch()](#getHeightInch--) | Represents the height of the shape, in unit of inches. | | [getHeightPt()](#getHeightPt--) | Represents the height of the shape, in unit of points. | | [getHeightScale()](#getHeightScale--) | Gets the height scale,in unit of percent of the original picture height. | | [getHtmlText()](#getHtmlText--) | Gets the html string which contains data and some formats in this textbox. | | [getHyperlink()](#getHyperlink--) | Gets the hyperlink of the shape. | | [getId()](#getId--) | Gets the identifier of this shape. | | [getInputRange()](#getInputRange--) | Gets the worksheet range used to fill the specified combo box. | | [getInputRange(boolean isR1C1, boolean isLocal)](#getInputRange-boolean-boolean-) | Gets the range used to fill the control. | | [getLeft()](#getLeft--) | Represents the horizontal offset of shape from its left column, in unit of pixels. | | [getLeftCM()](#getLeftCM--) | Represents the horizontal offset of shape from its left column, in unit of centimeters. | | [getLeftInShape()](#getLeftInShape--) | 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. | | [getLeftInch()](#getLeftInch--) | Represents the horizontal offset of shape from its left column, in unit of inches. | | [getLeftToCorner()](#getLeftToCorner--) | Gets the horizonal offset of shape from worksheet left border. | | [getLine()](#getLine--) | Gets line style | | [getLineFormat()](#getLineFormat--) | Returns a MsoLineFormat object that contains line formatting properties for the specified shape. | | [getLinkedCell()](#getLinkedCell--) | Gets the worksheet range linked to the control's value. | | [getLinkedCell(boolean isR1C1, boolean isLocal)](#getLinkedCell-boolean-boolean-) | Gets the range linked to the control's value. | | [getLockedProperty(int type)](#getLockedProperty-int-) | Gets the value of locked property. | | [getLowerDeltaX()](#getLowerDeltaX--) | Gets the shape's horizontal offset from its lower right corner column. | | [getLowerDeltaY()](#getLowerDeltaY--) | Gets the shape's vertical offset from its lower right corner row. | | [getLowerRightColumn()](#getLowerRightColumn--) | Represents lower right corner column index. | | [getLowerRightRow()](#getLowerRightRow--) | Represents lower right corner row index. | | [getMacroName()](#getMacroName--) | Gets the name of macro. | | [getMsoDrawingType()](#getMsoDrawingType--) | Gets drawing type. | | [getName()](#getName--) | Gets the name of the shape. | | [getPaths()](#getPaths--) | Gets the paths of a custom geometric shape. | | [getPlacement()](#getPlacement--) | Represents the way the drawing object is attached to the cells below it. | | [getReflection()](#getReflection--) | Represents a [ReflectionEffect](../../com.aspose.cells/reflectioneffect) object that specifies reflection effect for the chart element or shape. | | [getRelativeToOriginalPictureSize()](#getRelativeToOriginalPictureSize--) | Indicates whether shape is relative to original picture size. | | [getResultOfSmartArt()](#getResultOfSmartArt--) | Converting smart art to grouped shapes. | | [getRichFormattings()](#getRichFormattings--) | Returns all Characters objects that represents a range of characters within the text . | | [getRight()](#getRight--) | Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels. | | [getRotationAngle()](#getRotationAngle--) | Gets the rotation of the shape. | | [getShadowEffect()](#getShadowEffect--) | Represents a [ShadowEffect](../../com.aspose.cells/shadoweffect) object that specifies shadow effect for the chart element or shape. | | [getSoftEdges()](#getSoftEdges--) | Gets the radius of blur to apply to the edges, in unit of points. | | [getSpid()](#getSpid--) | Specifies an optional string identifier that an application can use to identify the particular shape. | | [getSpt()](#getSpt--) | Specifies an optional number that an application can use to associate the particular shape with a defined shape type. | | [getText()](#getText--) | Gets the text of this shape. | | [getTextBody()](#getTextBody--) | Gets the setting of the shape's text. | | [getTextBoxOptions()](#getTextBoxOptions--) | Gets the text information in the shape | | [getTextDirection()](#getTextDirection--) | Gets the direction of the text flow for this object. | | [getTextEffect()](#getTextEffect--) | Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. | | [getTextHorizontalAlignment()](#getTextHorizontalAlignment--) | Gets the text horizontal alignment type of the shape. | | [getTextHorizontalOverflow()](#getTextHorizontalOverflow--) | Gets the text horizontal overflow type of the shape which contains text. | | [getTextOptions()](#getTextOptions--) | Represents the text options of the shape. | | [getTextOrientationType()](#getTextOrientationType--) | Gets the text orientation type of the shape. | | [getTextShapeType()](#getTextShapeType--) | Gets the preset text shape type. | | [getTextVerticalAlignment()](#getTextVerticalAlignment--) | Gets the text vertical alignment type of the shape. | | [getTextVerticalOverflow()](#getTextVerticalOverflow--) | Gets the text vertical overflow type of the shape which contains text. | | [getThreeDFormat()](#getThreeDFormat--) | Gets 3d format of the shape. | | [getTitle()](#getTitle--) | Specifies the title (caption) of the current shape object. | | [getTop()](#getTop--) | Represents the vertical offset of shape from its top row, in unit of pixels. | | [getTopCM()](#getTopCM--) | Represents the vertical offset of shape from its top row, in unit of centimeters. | | [getTopInShape()](#getTopInShape--) | 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. | | [getTopInch()](#getTopInch--) | Represents the vertical offset of shape from its top row, in unit of inches. | | [getTopToCorner()](#getTopToCorner--) | Gets the vertical offset of shape from worksheet top border, in unit of pixels. | | [getType()](#getType--) | Gets the auto shape type. | | [getUpperDeltaX()](#getUpperDeltaX--) | Gets the shape's horizontal offset from its upper left corner column. | | [getUpperDeltaY()](#getUpperDeltaY--) | Gets the shape's vertical offset from its upper left corner row. | | [getUpperLeftColumn()](#getUpperLeftColumn--) | Represents upper left corner column index. | | [getUpperLeftRow()](#getUpperLeftRow--) | Represents the top row index. | | [getWidth()](#getWidth--) | Represents the width of shape, in unit of pixels. | | [getWidthCM()](#getWidthCM--) | Represents the width of the shape, in unit of centimeters. | | [getWidthInShape()](#getWidthInShape--) | Represents the width of the shape, in unit of 1/4000 of the parent shape. | | [getWidthInch()](#getWidthInch--) | Represents the width of the shape, in unit of inch. | | [getWidthPt()](#getWidthPt--) | Represents the width of the shape, in unit of point. | | [getWidthScale()](#getWidthScale--) | Gets the width scale, in unit of percent of the original picture width. | | [getWorksheet()](#getWorksheet--) | Gets the [Worksheet](../../com.aspose.cells/worksheet) object which contains this shape. | | [getX()](#getX--) | Gets the horizontal offset of shape from worksheet left border,in unit of pixels. | | [getY()](#getY--) | Gets the vertical offset of shape from worksheet top border,in unit of pixels. | | [getZOrderPosition()](#getZOrderPosition--) | Returns the position of a shape in the z-order. | | [hasLine()](#hasLine--) | Gets the line border of the shape is visible. | | [hashCode()](#hashCode--) | | | [isAspectRatioLocked()](#isAspectRatioLocked--) | True means that aspect ratio of the shape is locked. | | [isDecorative()](#isDecorative--) | Indicates whether the object is decorative. | | [isEquation()](#isEquation--) | Indicates whether the shape only contains an equation. | | [isFilled()](#isFilled--) | Indicates whether the fill format is visible. | | [isFlippedHorizontally()](#isFlippedHorizontally--) | Gets whether shape is horizontally flipped . | | [isFlippedVertically()](#isFlippedVertically--) | Gets whether shape is vertically flipped . | | [isGroup()](#isGroup--) | Indicates whether this shape is a group shape. | | [isHidden()](#isHidden--) | Indicates whether the object is visible. | | [isInGroup()](#isInGroup--) | Indicates whether the shape is grouped. | | [isLockAspectRatio()](#isLockAspectRatio--) | True means that aspect ratio of the shape is locked. | | [isLocked()](#isLocked--) | True means the object can not be modified when the sheet is protected. | | [isPrintable()](#isPrintable--) | Indicates whether the object is printable. | | [isRichText()](#isRichText--) | Whether or not the text is rich text. | | [isSameSetting(Object obj)](#isSameSetting-java.lang.Object-) | Returns whether the shape is same. | | [isSmartArt()](#isSmartArt--) | Indicates whether the shape is a smart art. | | [isTextWrapped()](#isTextWrapped--) | Gets the text wrapped type of the shape which contains text. | | [isWordArt()](#isWordArt--) | Indicates whether this shape is a word art. | | [moveToRange(int topRow, int leftColumn, int bottomRow, int rightColumn)](#moveToRange-int-int-int-int-) | Moves the shape to a specified range. | | [notify()](#notify--) | | | [notifyAll()](#notifyAll--) | | | [removeActiveXControl()](#removeActiveXControl--) | Remove activeX control. | | [removeHyperlink()](#removeHyperlink--) | Removes the hyperlink of the shape. | | [setAlternativeText(String value)](#setAlternativeText-java.lang.String-) | Returns or sets the descriptive (alternative) text string of the [Shape](../../com.aspose.cells/shape) object. | | [setAnchorType(int value)](#setAnchorType-int-) | Sets the type of the shape anchor placeholder. | | [setAspectRatioLocked(boolean value)](#setAspectRatioLocked-boolean-) | True means that aspect ratio of the shape is locked. | | [setAutoShapeType(int value)](#setAutoShapeType-int-) | Sets the auto shape type. | | [setBottom(int value)](#setBottom-int-) | Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels. | | [setCreateId(UUID value)](#setCreateId-java.util.UUID-) | Sets create id for this shape. | | [setDecorative(boolean value)](#setDecorative-boolean-) | Indicates whether the object is decorative. | | [setFilled(boolean value)](#setFilled-boolean-) | Indicates whether the fill format is visible. | | [setFlippedHorizontally(boolean value)](#setFlippedHorizontally-boolean-) | Sets whether shape is horizontally flipped . | | [setFlippedVertically(boolean value)](#setFlippedVertically-boolean-) | Sets whether shape is vertically flipped . | | [setFont(Font value)](#setFont-com.aspose.cells.Font-) | Represents the font of shape. | | [setHasLine(boolean value)](#setHasLine-boolean-) | Sets the line border of the shape is visible. | | [setHeight(int value)](#setHeight-int-) | Represents the height of shape, in unit of pixel. | | [setHeightCM(double value)](#setHeightCM-double-) | Represents the height of the shape, in unit of centimeters. | | [setHeightInShape(int value)](#setHeightInShape-int-) | 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.. | | [setHeightInch(double value)](#setHeightInch-double-) | Represents the height of the shape, in unit of inches. | | [setHeightPt(double value)](#setHeightPt-double-) | Represents the height of the shape, in unit of points. | | [setHeightScale(int value)](#setHeightScale-int-) | Sets the height scale,in unit of percent of the original picture height. | | [setHidden(boolean value)](#setHidden-boolean-) | Indicates whether the object is visible. | | [setHtmlText(String value)](#setHtmlText-java.lang.String-) | Sets the html string which contains data and some formats in this textbox. | | [setInputRange(String value)](#setInputRange-java.lang.String-) | Sets the worksheet range used to fill the specified combo box. | | [setInputRange(String formula, boolean isR1C1, boolean isLocal)](#setInputRange-java.lang.String-boolean-boolean-) | Sets the range used to fill the control. | | [setLeft(int value)](#setLeft-int-) | Represents the horizontal offset of shape from its left column, in unit of pixels. | | [setLeftCM(double value)](#setLeftCM-double-) | Represents the horizontal offset of shape from its left column, in unit of centimeters. | | [setLeftInShape(int value)](#setLeftInShape-int-) | 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. | | [setLeftInch(double value)](#setLeftInch-double-) | Represents the horizontal offset of shape from its left column, in unit of inches. | | [setLeftToCorner(int value)](#setLeftToCorner-int-) | Sets the horizonal offset of shape from worksheet left border. | | [setLinkedCell(String value)](#setLinkedCell-java.lang.String-) | Sets the worksheet range linked to the control's value. | | [setLinkedCell(String formula, boolean isR1C1, boolean isLocal)](#setLinkedCell-java.lang.String-boolean-boolean-) | Sets the range linked to the control's value. | | [setLockAspectRatio(boolean value)](#setLockAspectRatio-boolean-) | True means that aspect ratio of the shape is locked. | | [setLocked(boolean value)](#setLocked-boolean-) | True means the object can not be modified when the sheet is protected. | | [setLockedProperty(int type, boolean value)](#setLockedProperty-int-boolean-) | Set the locked property. | | [setLowerDeltaX(int value)](#setLowerDeltaX-int-) | Sets the shape's horizontal offset from its lower right corner column. | | [setLowerDeltaY(int value)](#setLowerDeltaY-int-) | Sets the shape's vertical offset from its lower right corner row. | | [setLowerRightColumn(int value)](#setLowerRightColumn-int-) | Represents lower right corner column index. | | [setLowerRightRow(int value)](#setLowerRightRow-int-) | Represents lower right corner row index. | | [setMacroName(String value)](#setMacroName-java.lang.String-) | Sets the name of macro. | | [setName(String value)](#setName-java.lang.String-) | Sets the name of the shape. | | [setPlacement(int value)](#setPlacement-int-) | Represents the way the drawing object is attached to the cells below it. | | [setPrintable(boolean value)](#setPrintable-boolean-) | Indicates whether the object is printable. | | [setRelativeToOriginalPictureSize(boolean value)](#setRelativeToOriginalPictureSize-boolean-) | Indicates whether shape is relative to original picture size. | | [setRight(int value)](#setRight-int-) | Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels. | | [setRotationAngle(double value)](#setRotationAngle-double-) | Sets the rotation of the shape. | | [setSoftEdges(double value)](#setSoftEdges-double-) | Sets the radius of blur to apply to the edges, in unit of points. | | [setText(String value)](#setText-java.lang.String-) | Sets the text of this shape. | | [setTextDirection(int value)](#setTextDirection-int-) | Sets the direction of the text flow for this object. | | [setTextHorizontalAlignment(int value)](#setTextHorizontalAlignment-int-) | Sets the text horizontal alignment type of the shape. | | [setTextHorizontalOverflow(int value)](#setTextHorizontalOverflow-int-) | Sets the text horizontal overflow type of the shape which contains text. | | [setTextOptions(TextOptions value)](#setTextOptions-com.aspose.cells.TextOptions-) | Represents the text options of the shape. | | [setTextOrientationType(int value)](#setTextOrientationType-int-) | Sets the text orientation type of the shape. | | [setTextShapeType(int value)](#setTextShapeType-int-) | Sets the preset text shape type. | | [setTextVerticalAlignment(int value)](#setTextVerticalAlignment-int-) | Sets the text vertical alignment type of the shape. | | [setTextVerticalOverflow(int value)](#setTextVerticalOverflow-int-) | Sets the text vertical overflow type of the shape which contains text. | | [setTextWrapped(boolean value)](#setTextWrapped-boolean-) | Sets the text wrapped type of the shape which contains text. | | [setTitle(String value)](#setTitle-java.lang.String-) | Specifies the title (caption) of the current shape object. | | [setTop(int value)](#setTop-int-) | Represents the vertical offset of shape from its top row, in unit of pixels. | | [setTopCM(double value)](#setTopCM-double-) | Represents the vertical offset of shape from its top row, in unit of centimeters. | | [setTopInShape(int value)](#setTopInShape-int-) | 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. | | [setTopInch(double value)](#setTopInch-double-) | Represents the vertical offset of shape from its top row, in unit of inches. | | [setTopToCorner(int value)](#setTopToCorner-int-) | Sets the vertical offset of shape from worksheet top border, in unit of pixels. | | [setUpperDeltaX(int value)](#setUpperDeltaX-int-) | Sets the shape's horizontal offset from its upper left corner column. | | [setUpperDeltaY(int value)](#setUpperDeltaY-int-) | Sets the shape's vertical offset from its upper left corner row. | | [setUpperLeftColumn(int value)](#setUpperLeftColumn-int-) | Represents upper left corner column index. | | [setUpperLeftRow(int value)](#setUpperLeftRow-int-) | Represents the top row index. | | [setWidth(int value)](#setWidth-int-) | Represents the width of shape, in unit of pixels. | | [setWidthCM(double value)](#setWidthCM-double-) | Represents the width of the shape, in unit of centimeters. | | [setWidthInShape(int value)](#setWidthInShape-int-) | Represents the width of the shape, in unit of 1/4000 of the parent shape. | | [setWidthInch(double value)](#setWidthInch-double-) | Represents the width of the shape, in unit of inch. | | [setWidthPt(double value)](#setWidthPt-double-) | Represents the width of the shape, in unit of point. | | [setWidthScale(int value)](#setWidthScale-int-) | Sets the width scale, in unit of percent of the original picture width. | | [setX(int value)](#setX-int-) | Sets the horizontal offset of shape from worksheet left border,in unit of pixels. | | [setY(int value)](#setY-int-) | Sets the vertical offset of shape from worksheet top border,in unit of pixels. | | [setZOrderPosition(int value)](#setZOrderPosition-int-) | Returns the position of a shape in the z-order. | | [toFrontOrBack(int orders)](#toFrontOrBack-int-) | Brings the shape to the front or sends the shape to back. | | [toImage(OutputStream stream, ImageFormat imageFormat)](#toImage-java.io.OutputStream-com.aspose.cells.ImageFormat-) | Creates the shape image and saves it to a stream in the specified format. | | [toImage(OutputStream stream, ImageOrPrintOptions options)](#toImage-java.io.OutputStream-com.aspose.cells.ImageOrPrintOptions-) | Saves the shape to a stream. | | [toImage(String imageFile, ImageOrPrintOptions options)](#toImage-java.lang.String-com.aspose.cells.ImageOrPrintOptions-) | Saves the shape to a file. | | [toString()](#toString--) | | | [updateSelectedValue()](#updateSelectedValue--) | Update the selected value by the value of the linked cell. | | [wait()](#wait--) | | | [wait(long arg0)](#wait-long-) | | | [wait(long arg0, int arg1)](#wait-long-int-) | | ### addHyperlink(String address) {#addHyperlink-java.lang.String-} ``` public Hyperlink addHyperlink(String address) ``` Adds a hyperlink to the shape. **Example** ``` Hyperlink hyperlink = shape.addHyperlink("https://www.aspose.com/"); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | address | java.lang.String | Address of the hyperlink. | **Returns:** [Hyperlink](../../com.aspose.cells/hyperlink) - Returns the new hyperlink object. ### alignTopRightCorner(int topRow, int rightColumn) {#alignTopRightCorner-int-int-} ``` public void alignTopRightCorner(int topRow, int rightColumn) ``` Moves the picture to the top-right corner. **Example** ``` shape.alignTopRightCorner(2, 5); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | topRow | int | the row index. | | rightColumn | int | the column index. | ### calculateTextSize() {#calculateTextSize--} ``` public int[] calculateTextSize() ``` Recalculate the text area **Example** ``` //The size of the text area is:w=size[0],h=size[1] int[] size = shape.calculateTextSize(); ``` **Returns:** int[] - Text's Size in an array(width and height). ### characters(int startIndex, int length) {#characters-int-int-} ``` public FontSetting characters(int startIndex, int length) ``` Returns a Characters object that represents a range of characters within the text. **Remarks** This method only works on shape with title. **Example** ``` FontSetting fontSetting = shape.characters(0, 4); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | startIndex | int | The index of the start of the character. | | length | int | The number of characters. | **Returns:** [FontSetting](../../com.aspose.cells/fontsetting) - Characters object. ### equals(Object arg0) {#equals-java.lang.Object-} ``` public boolean equals(Object arg0) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | arg0 | java.lang.Object | | **Returns:** boolean ### fitToTextSize() {#fitToTextSize--} ``` public void fitToTextSize() ``` Recalculate a text area suitable for displaying all text content. **Example** ``` if (shape.getName().startsWith("Your traget")) { shape.fitToTextSize(); } ``` ### formatCharacters(int startIndex, int length, Font font, StyleFlag flag) {#formatCharacters-int-int-com.aspose.cells.Font-com.aspose.cells.StyleFlag-} ``` public void formatCharacters(int startIndex, int length, Font font, StyleFlag flag) ``` Formats some characters with the font setting. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | startIndex | int | The start index. | | length | int | The length. | | font | [Font](../../com.aspose.cells/font) | The font setting. | | flag | [StyleFlag](../../com.aspose.cells/styleflag) | The flag of the font setting. | ### getActiveXControl() {#getActiveXControl--} ``` public ActiveXControl getActiveXControl() ``` Gets the ActiveX control. **Example** ``` if(shape.getActiveXControl() != null) { CheckBoxActiveXControl checkBox1 = (CheckBoxActiveXControl)shape.getActiveXControl(); //The font name of CheckBox String fontName = checkBox1.getFont().getName(); } ``` **Returns:** [ActiveXControl](../../com.aspose.cells/activexcontrol) ### getActualBox() {#getActualBox--} ``` public float[] getActualBox() ``` Get the actual position and size of the shape (after applying rotation, flip, etc.) **Remarks** 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. **Example** ``` float[] box = shape.getActualBox(); System.out.println("x = " + box[0]); System.out.println("y = " + box[1]); System.out.println("w = " + box[2]); System.out.println("h = " + box[3]); ``` **Returns:** float[] - Returns the position and size in the order of x, y, w, h ### getActualLowerRightRow() {#getActualLowerRightRow--} ``` public int getActualLowerRightRow() ``` Get the actual bottom row. **Example** ``` int rRow = shape.getActualLowerRightRow(); ``` **Returns:** int ### getAlternativeText() {#getAlternativeText--} ``` public String getAlternativeText() ``` Returns or sets the descriptive (alternative) text string of the [Shape](../../com.aspose.cells/shape) object. **Example** ``` shape.setAlternativeText("a rectangle"); ``` **Returns:** java.lang.String ### getAnchorType() {#getAnchorType--} ``` public int getAnchorType() ``` Gets the type of the shape anchor placeholder. See [ShapeAnchorType](../../com.aspose.cells/shapeanchortype). **Example** ``` if (shape.getAnchorType() == ShapeAnchorType.ONE_CELL_ANCHOR) shape.setAnchorType(ShapeAnchorType.TWO_CELL_ANCHOR); ``` **Returns:** int ### getAutoShapeType() {#getAutoShapeType--} ``` public int getAutoShapeType() ``` Gets the auto shape type. See [AutoShapeType](../../com.aspose.cells/autoshapetype). **Example** ``` if (shape.getAutoShapeType() == com.aspose.cells.AutoShapeType.UNKNOWN) shape.setAutoShapeType(com.aspose.cells.AutoShapeType.RECTANGLE); ``` **Returns:** int ### getBottom() {#getBottom--} ``` public int getBottom() ``` Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels. **Example** ``` if (shape.getBottom() == 3) shape.setBottom(1); ``` **Returns:** int ### getCharacters() {#getCharacters--} ``` public ArrayList getCharacters() ``` Returns all Characters objects that represents a range of characters within the text . **Remarks** 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. **Example** ``` FontSetting fontSetting = shape.characters(0, 4); ``` **Returns:** java.util.ArrayList - All Characters objects ### getClass() {#getClass--} ``` public final native Class getClass() ``` **Returns:** java.lang.Class ### getConnectionPoints() {#getConnectionPoints--} ``` public float[][] getConnectionPoints() ``` Get the connection points **Example** ``` float[][] points = shape.getConnectionPoints(); ``` **Returns:** float[][] - [X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y. ### getControlData() {#getControlData--} ``` public byte[] getControlData() ``` Gets the data of control. **Example** ``` if(shape.getControlData() == null) System.out.println("No data."); ``` **Returns:** byte[] ### getCreateId() {#getCreateId--} ``` public UUID getCreateId() ``` Gets create id for this shape. **Example** ``` System.out.println(shape.getCreateId()); java.util.UUID g = java.util.UUID.randomUUID(); shape.setCreateId(g); System.out.println(shape.getCreateId()); ``` **Returns:** java.util.UUID ### getEquationParagraph() {#getEquationParagraph--} ``` public EquationNode getEquationParagraph() ``` Gets the first math paragraph from the TextBody property of the TextBox object. **Returns:** [EquationNode](../../com.aspose.cells/equationnode) - If there has math paragraph, returns the first one, otherwise returns null. ### getEquationParagraph(int index) {#getEquationParagraph-int-} ``` public EquationNode getEquationParagraph(int index) ``` Get the specified math paragraph from the TextBody property of the TextBox object. Notice: (1) Returns NULL when the index is out of bounds or not found. (2) Also returns NULL if the specified index position is not a math paragraph. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | index | int | The position index of the math paragraph, starting from 0. | **Returns:** [EquationNode](../../com.aspose.cells/equationnode) - Returns the math paragraph specified by index. ### getFill() {#getFill--} ``` public FillFormat getFill() ``` Returns a [getFillFormat()](../../com.aspose.cells/shape\#getFillFormat--) object that contains fill formatting properties for the specified shape. **Example** ``` FillFormat fillFmt = shape.getFill(); ``` **Returns:** [FillFormat](../../com.aspose.cells/fillformat) ### getFillFormat() {#getFillFormat--} ``` public MsoFillFormat getFillFormat() ``` Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. **Remarks** 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. **Returns:** [MsoFillFormat](../../com.aspose.cells/msofillformat) ### getFont() {#getFont--} ``` public Font getFont() ``` Represents the font of shape. **Example** ``` Font font = shape.getFont(); font.setName("Arial"); font.setSize(12); font.setColor(Color.getRed()); ``` **Returns:** [Font](../../com.aspose.cells/font) ### getFormatPicture() {#getFormatPicture--} ``` public MsoFormatPicture getFormatPicture() ``` Gets the options of the picture format. **Example** ``` MsoFormatPicture msoFormatPicture = shape.getFormatPicture(); ``` **Returns:** [MsoFormatPicture](../../com.aspose.cells/msoformatpicture) ### getGeometry() {#getGeometry--} ``` public Geometry getGeometry() ``` Gets the geometry **Example** ``` if (shape.getGeometry() != null &&shape.getGeometry().getShapeAdjustValues().getCount() == 0) System.out.println("No geometry path."); ``` **Returns:** [Geometry](../../com.aspose.cells/geometry) ### getGlow() {#getGlow--} ``` public GlowEffect getGlow() ``` Represents a [GlowEffect](../../com.aspose.cells/gloweffect) object that specifies glow effect for the chart element or shape. **Example** ``` GlowEffect glowEffect = shape.getGlow(); ``` **Returns:** [GlowEffect](../../com.aspose.cells/gloweffect) ### getGroup() {#getGroup--} ``` public GroupShape getGroup() ``` Gets the group shape which contains this shape. **Example** ``` GroupShape groupShape = shape.getGroup(); ``` **Returns:** [GroupShape](../../com.aspose.cells/groupshape) ### getHeight() {#getHeight--} ``` public int getHeight() ``` Represents the height of shape, in unit of pixel. **Example** ``` if (shape.getHeight() == 3) shape.setHeight(1); ``` **Returns:** int ### getHeightCM() {#getHeightCM--} ``` public double getHeightCM() ``` Represents the height of the shape, in unit of centimeters. **Example** ``` if (shape.getHeightCM() == 3) shape.setHeightCM(1); ``` **Returns:** double ### getHeightInShape() {#getHeightInShape--} ``` public int getHeightInShape() ``` 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.. **Remarks** Only Applies when this shape in the group or chart. **Example** ``` if (shape.isInGroup() &&shape.getHeightInShape() == 4000) shape.setHeightInShape(2000); ``` **Returns:** int ### getHeightInch() {#getHeightInch--} ``` public double getHeightInch() ``` Represents the height of the shape, in unit of inches. **Example** ``` if (shape.getHeightInch() == 3) shape.setHeightInch(1); ``` **Returns:** double ### getHeightPt() {#getHeightPt--} ``` public double getHeightPt() ``` Represents the height of the shape, in unit of points. **Example** ``` if (shape.getHeightPt() == 3) shape.setHeightPt(1); ``` **Returns:** double ### getHeightScale() {#getHeightScale--} ``` public int getHeightScale() ``` Gets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100; **Example** ``` if (shape.getHeightScale() == 3) shape.setHeightScale(1); ``` **Returns:** int ### getHtmlText() {#getHtmlText--} ``` public String getHtmlText() ``` Gets the html string which contains data and some formats in this textbox. **Example** ``` String html = shape.getHtmlText(); if(html == null || "".equals(html)) { shape.setHtmlText("This is a test."); } ``` **Returns:** java.lang.String ### getHyperlink() {#getHyperlink--} ``` public Hyperlink getHyperlink() ``` Gets the hyperlink of the shape. **Example** ``` Hyperlink hyperlink = shape.getHyperlink(); ``` **Returns:** [Hyperlink](../../com.aspose.cells/hyperlink) ### getId() {#getId--} ``` public int getId() ``` Gets the identifier of this shape. **Example** ``` int id = shape.getId(); ``` **Returns:** int ### getInputRange() {#getInputRange--} ``` public String getInputRange() ``` Gets the worksheet range used to fill the specified combo box. **Example** ``` if (shape.getInputRange().equals("$B$6:$B10")) shape.setInputRange("$A$1:$A$5"); ``` **Returns:** java.lang.String ### getInputRange(boolean isR1C1, boolean isLocal) {#getInputRange-boolean-boolean-} ``` public String getInputRange(boolean isR1C1, boolean isLocal) ``` Gets the range used to fill the control. **Example** ``` String range = shape.getInputRange(false, true); //If successful, a value like "$A$1:$A$3" will be returned ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. | | isLocal | boolean | Whether the formula needs to be formatted by locale. | **Returns:** java.lang.String - The range used to fill the control. ### getLeft() {#getLeft--} ``` public int getLeft() ``` Represents the horizontal offset of shape from its left column, in unit of pixels. **Example** ``` if (shape.getLeft() == 3) shape.setLeft(1); ``` **Returns:** int ### getLeftCM() {#getLeftCM--} ``` public double getLeftCM() ``` Represents the horizontal offset of shape from its left column, in unit of centimeters. **Example** ``` if (shape.getLeftCM() == 3) shape.setLeftCM(1); ``` **Returns:** double ### getLeftInShape() {#getLeftInShape--} ``` public int getLeftInShape() ``` 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. **Remarks** Only Applies when this shape in the group or chart. **Example** ``` if (shape.isInGroup() &&shape.getLeftInShape() == 2000) shape.setLeftInShape(4000); ``` **Returns:** int ### getLeftInch() {#getLeftInch--} ``` public double getLeftInch() ``` Represents the horizontal offset of shape from its left column, in unit of inches. **Example** ``` if (shape.getLeftInch() == 3) shape.setLeftInch(1); ``` **Returns:** double ### getLeftToCorner() {#getLeftToCorner--} ``` public int getLeftToCorner() ``` Gets the horizonal offset of shape from worksheet left border. **Example** ``` if (shape.getLeftToCorner() == 3) shape.setLeftToCorner(1); ``` **Returns:** int ### getLine() {#getLine--} ``` public LineFormat getLine() ``` Gets line style **Example** ``` LineFormat lineFmt = shape.getLine(); ``` **Returns:** [LineFormat](../../com.aspose.cells/lineformat) ### getLineFormat() {#getLineFormat--} ``` public MsoLineFormat getLineFormat() ``` Returns a MsoLineFormat object that contains line formatting properties for the specified shape. **Remarks** 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. **Returns:** [MsoLineFormat](../../com.aspose.cells/msolineformat) ### getLinkedCell() {#getLinkedCell--} ``` public String getLinkedCell() ``` Gets the worksheet range linked to the control's value. **Example** ``` if (shape.getLinkedCell().equals("$B$6")) { shape.setLinkedCell("A1"); } shape.updateSelectedValue(); ``` **Returns:** java.lang.String ### getLinkedCell(boolean isR1C1, boolean isLocal) {#getLinkedCell-boolean-boolean-} ``` public String getLinkedCell(boolean isR1C1, boolean isLocal) ``` Gets the range linked to the control's value. **Example** ``` //You may get results like '$A$1' String link = shape.getLinkedCell(false, false); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | isR1C1 | boolean | Whether the formula needs to be formatted as R1C1. | | isLocal | boolean | Whether the formula needs to be formatted by locale. | **Returns:** java.lang.String - The range linked to the control's value. ### getLockedProperty(int type) {#getLockedProperty-int-} ``` public boolean getLockedProperty(int type) ``` Gets the value of locked property. **Example** ``` int noAdjustHandles = 0; if (shape.getLockedProperty(ShapeLockType.ADJUST_HANDLES)) noAdjustHandles = 1; ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | type | int | [ShapeLockType](../../com.aspose.cells/shapelocktype). The type of the shape locked property. | **Returns:** boolean - Returns the value of locked property. ### getLowerDeltaX() {#getLowerDeltaX--} ``` public int getLowerDeltaX() ``` Gets the shape's horizontal offset from its lower right corner column. **Remarks** The range of value is 0 to 1024. **Example** ``` if (shape.getLowerDeltaX() == 3) shape.setLowerDeltaX(1); ``` **Returns:** int ### getLowerDeltaY() {#getLowerDeltaY--} ``` public int getLowerDeltaY() ``` Gets the shape's vertical offset from its lower right corner row. **Remarks** The range of value is 0 to 256. **Example** ``` if (shape.getLowerDeltaY() == 3) shape.setLowerDeltaY(1); ``` **Returns:** int ### getLowerRightColumn() {#getLowerRightColumn--} ``` public int getLowerRightColumn() ``` Represents lower right corner column index. **Example** ``` if (shape.getLowerRightColumn() == 3) shape.setLowerRightColumn(1); ``` **Returns:** int ### getLowerRightRow() {#getLowerRightRow--} ``` public int getLowerRightRow() ``` Represents lower right corner row index. **Example** ``` if (shape.getLowerRightRow() == 3) shape.setLowerRightRow(1); ``` **Returns:** int ### getMacroName() {#getMacroName--} ``` public String getMacroName() ``` Gets the name of macro. **Example** ``` //Sets the name of macro. shape.setMacroName("DoWork()"); ``` **Returns:** java.lang.String ### getMsoDrawingType() {#getMsoDrawingType--} ``` public int getMsoDrawingType() ``` Gets drawing type. See [MsoDrawingType](../../com.aspose.cells/msodrawingtype). **Example** ``` /*Aspose.Cells.Drawing.MsoDrawingType*/int msoDrawingType = shape.getMsoDrawingType(); ``` **Returns:** int ### getName() {#getName--} ``` public String getName() ``` Gets the name of the shape. **Example** ``` shape.setName("shape1"); ``` **Returns:** java.lang.String ### getPaths() {#getPaths--} ``` public ShapePathCollection getPaths() ``` Gets the paths of a custom geometric shape. **Example** ``` //Returns non-null if there is a path to the custom geometry if(shape.getPaths() == null) System.out.println("No custom geometry path."); ``` **Returns:** [ShapePathCollection](../../com.aspose.cells/shapepathcollection) ### getPlacement() {#getPlacement--} ``` public int getPlacement() ``` Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. See [PlacementType](../../com.aspose.cells/placementtype). **Example** ``` if (shape.getPlacement() == PlacementType.MOVE) shape.setPlacement(PlacementType.MOVE_AND_SIZE); ``` **Returns:** int ### getReflection() {#getReflection--} ``` public ReflectionEffect getReflection() ``` Represents a [ReflectionEffect](../../com.aspose.cells/reflectioneffect) object that specifies reflection effect for the chart element or shape. **Example** ``` ReflectionEffect reflectionEffect = shape.getReflection(); ``` **Returns:** [ReflectionEffect](../../com.aspose.cells/reflectioneffect) ### getRelativeToOriginalPictureSize() {#getRelativeToOriginalPictureSize--} ``` public boolean getRelativeToOriginalPictureSize() ``` Indicates whether shape is relative to original picture size. **Example** ``` if(shape.getRelativeToOriginalPictureSize()) shape.setRelativeToOriginalPictureSize(false); ``` **Returns:** boolean ### getResultOfSmartArt() {#getResultOfSmartArt--} ``` public GroupShape getResultOfSmartArt() ``` Converting smart art to grouped shapes. **Example** ``` if(shape.isSmartArt()) { GroupShape groupShape = shape.getResultOfSmartArt(); } ``` **Returns:** [GroupShape](../../com.aspose.cells/groupshape) ### getRichFormattings() {#getRichFormattings--} ``` public FontSetting[] getRichFormattings() ``` Returns all Characters objects that represents a range of characters within the text . **Example** ``` FontSetting[] list = shape.getRichFormattings(); ``` **Returns:** com.aspose.cells.FontSetting[] - All Characters objects ### getRight() {#getRight--} ``` public int getRight() ``` Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels. **Example** ``` if (shape.getRight() == 3) shape.setRight(1); ``` **Returns:** int ### getRotationAngle() {#getRotationAngle--} ``` public double getRotationAngle() ``` Gets the rotation of the shape. **Example** ``` //Gets rotation angle of the shape. double angle = shape.getRotationAngle() ; //Gets rotation angle of the shape. shape.setRotationAngle(60); ``` **Returns:** double ### getShadowEffect() {#getShadowEffect--} ``` public ShadowEffect getShadowEffect() ``` Represents a [ShadowEffect](../../com.aspose.cells/shadoweffect) object that specifies shadow effect for the chart element or shape. **Example** ``` ShadowEffect shadowEffect = shape.getShadowEffect(); ``` **Returns:** [ShadowEffect](../../com.aspose.cells/shadoweffect) ### getSoftEdges() {#getSoftEdges--} ``` public double getSoftEdges() ``` Gets the radius of blur to apply to the edges, in unit of points. **Example** ``` shape.setSoftEdges(0.5d); ``` **Returns:** double ### getSpid() {#getSpid--} ``` public String getSpid() ``` Specifies an optional string identifier that an application can use to identify the particular shape. **Example** ``` String spid = shape.getSpid(); ``` **Returns:** java.lang.String ### getSpt() {#getSpt--} ``` public int getSpt() ``` Specifies an optional number that an application can use to associate the particular shape with a defined shape type. **Example** ``` int spt = shape.getSpt(); ``` **Returns:** int ### getText() {#getText--} ``` public String getText() ``` Gets the text of this shape. **Example** ``` if(shape.getText() == null) shape.setText("This is a test."); ``` **Returns:** java.lang.String ### getTextBody() {#getTextBody--} ``` public FontSettingCollection getTextBody() ``` Gets the setting of the shape's text. **Example** ``` FontSettingCollection fontSettingCollection = shape.getTextBody(); fontSettingCollection.setText("This is a test."); ``` **Returns:** [FontSettingCollection](../../com.aspose.cells/fontsettingcollection) ### getTextBoxOptions() {#getTextBoxOptions--} ``` public TextBoxOptions getTextBoxOptions() ``` Gets the text information in the shape **Example** ``` TextBoxOptions textBoxOpt = shape.getTextBoxOptions(); textBoxOpt.setShapeTextVerticalAlignment(ShapeTextVerticalAlignmentType.LEFT); textBoxOpt.setTopMarginPt(0.2d); textBoxOpt.setLeftMarginPt(0.2d); textBoxOpt.setRightMarginPt(0.2d); textBoxOpt.setBottomMarginPt(0.2d); ``` **Returns:** [TextBoxOptions](../../com.aspose.cells/textboxoptions) ### getTextDirection() {#getTextDirection--} ``` public int getTextDirection() ``` Gets the direction of the text flow for this object. See [TextDirectionType](../../com.aspose.cells/textdirectiontype). **Example** ``` if (shape.getTextDirection() == com.aspose.cells.TextDirectionType.CONTEXT) shape.setTextDirection(com.aspose.cells.TextDirectionType.LEFT_TO_RIGHT); ``` **Returns:** int ### getTextEffect() {#getTextEffect--} ``` public TextEffectFormat getTextEffect() ``` Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt. **Example** ``` if(shape.isWordArt()) { TextEffectFormat textEffectFormat = shape.getTextEffect(); } ``` **Returns:** [TextEffectFormat](../../com.aspose.cells/texteffectformat) ### getTextHorizontalAlignment() {#getTextHorizontalAlignment--} ``` public int getTextHorizontalAlignment() ``` Gets the text horizontal alignment type of the shape. See [TextAlignmentType](../../com.aspose.cells/textalignmenttype). **Example** ``` if (shape.getTextHorizontalAlignment() == com.aspose.cells.TextAlignmentType.BOTTOM) shape.setTextHorizontalAlignment(com.aspose.cells.TextAlignmentType.CENTER); ``` **Returns:** int ### getTextHorizontalOverflow() {#getTextHorizontalOverflow--} ``` public int getTextHorizontalOverflow() ``` Gets the text horizontal overflow type of the shape which contains text. See [TextOverflowType](../../com.aspose.cells/textoverflowtype). **Example** ``` if (shape.getTextHorizontalOverflow() == com.aspose.cells.TextOverflowType.CLIP) shape.setTextHorizontalOverflow(com.aspose.cells.TextOverflowType.OVERFLOW); ``` **Returns:** int ### getTextOptions() {#getTextOptions--} ``` public TextOptions getTextOptions() ``` Represents the text options of the shape. **Example** ``` TextOptions opt = shape.getTextOptions(); opt.setColor(Color.getBlue()); opt.setSize(8); ``` **Returns:** [TextOptions](../../com.aspose.cells/textoptions) ### getTextOrientationType() {#getTextOrientationType--} ``` public int getTextOrientationType() ``` Gets the text orientation type of the shape. See [TextOrientationType](../../com.aspose.cells/textorientationtype). **Example** ``` if (shape.getTextOrientationType() == com.aspose.cells.TextOrientationType.NO_ROTATION) shape.setTextOrientationType(com.aspose.cells.TextOrientationType.TOP_TO_BOTTOM); ``` **Returns:** int ### getTextShapeType() {#getTextShapeType--} ``` public int getTextShapeType() ``` Gets the preset text shape type. See [AutoShapeType](../../com.aspose.cells/autoshapetype). **Example** ``` if (shape.getTextShapeType() == com.aspose.cells.AutoShapeType.UNKNOWN) shape.setTextShapeType(com.aspose.cells.AutoShapeType.RECTANGLE); ``` **Returns:** int ### getTextVerticalAlignment() {#getTextVerticalAlignment--} ``` public int getTextVerticalAlignment() ``` Gets the text vertical alignment type of the shape. See [TextAlignmentType](../../com.aspose.cells/textalignmenttype). **Example** ``` if (shape.getTextVerticalAlignment() == com.aspose.cells.TextAlignmentType.BOTTOM) shape.setTextVerticalAlignment(com.aspose.cells.TextAlignmentType.CENTER); ``` **Returns:** int ### getTextVerticalOverflow() {#getTextVerticalOverflow--} ``` public int getTextVerticalOverflow() ``` Gets the text vertical overflow type of the shape which contains text. See [TextOverflowType](../../com.aspose.cells/textoverflowtype). **Example** ``` if (shape.getTextVerticalOverflow() == com.aspose.cells.TextOverflowType.CLIP) shape.setTextVerticalOverflow(com.aspose.cells.TextOverflowType.OVERFLOW); ``` **Returns:** int ### getThreeDFormat() {#getThreeDFormat--} ``` public ThreeDFormat getThreeDFormat() ``` Gets 3d format of the shape. **Example** ``` ThreeDFormat threeDFormat = shape.getThreeDFormat(); ``` **Returns:** [ThreeDFormat](../../com.aspose.cells/threedformat) ### getTitle() {#getTitle--} ``` public String getTitle() ``` Specifies the title (caption) of the current shape object. **Example** ``` shape.setTitle("title1"); ``` **Returns:** java.lang.String ### getTop() {#getTop--} ``` public int getTop() ``` Represents the vertical offset of shape from its top row, in unit of pixels. **Remarks** If the shape is in the chart, represents the vertical offset of shape from its top border. **Example** ``` if (shape.getTop() == 3) shape.setTop(1); ``` **Returns:** int ### getTopCM() {#getTopCM--} ``` public double getTopCM() ``` Represents the vertical offset of shape from its top row, in unit of centimeters. **Example** ``` if (shape.getTopCM() == 3) shape.setTopCM(1); ``` **Returns:** double ### getTopInShape() {#getTopInShape--} ``` public int getTopInShape() ``` 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. **Remarks** Only Applies when this shape in the group or chart. **Example** ``` if (shape.isInGroup() &&shape.getTopInShape() == 8000) shape.setTopInShape(4000); ``` **Returns:** int ### getTopInch() {#getTopInch--} ``` public double getTopInch() ``` Represents the vertical offset of shape from its top row, in unit of inches. **Example** ``` if (shape.getTopInch() == 3) shape.setTopInch(1); ``` **Returns:** double ### getTopToCorner() {#getTopToCorner--} ``` public int getTopToCorner() ``` Gets the vertical offset of shape from worksheet top border, in unit of pixels. **Example** ``` if (shape.getTopToCorner() == 3) shape.setTopToCorner(1); ``` **Returns:** int ### getType() {#getType--} ``` public int getType() ``` Gets the auto shape type. See [AutoShapeType](../../com.aspose.cells/autoshapetype). **Example** ``` /*Aspose.Cells.Drawing.AutoShapeType*/int autoShapeType = shape.getType(); ``` **Returns:** int ### getUpperDeltaX() {#getUpperDeltaX--} ``` public int getUpperDeltaX() ``` Gets the shape's horizontal offset from its upper left corner column. **Remarks** The range of value is 0 to 1024. **Example** ``` if (shape.getUpperDeltaX() == 3) shape.setUpperDeltaX(1); ``` **Returns:** int ### getUpperDeltaY() {#getUpperDeltaY--} ``` public int getUpperDeltaY() ``` Gets the shape's vertical offset from its upper left corner row. **Remarks** The range of value is 0 to 256. **Example** ``` if (shape.getUpperDeltaY() == 3) shape.setUpperDeltaY(1); ``` **Returns:** int ### getUpperLeftColumn() {#getUpperLeftColumn--} ``` public int getUpperLeftColumn() ``` Represents upper left corner column index. **Example** ``` if (shape.getUpperLeftColumn() == 3) shape.setUpperLeftColumn(1); ``` **Returns:** int ### getUpperLeftRow() {#getUpperLeftRow--} ``` public int getUpperLeftRow() ``` Represents the top row index. **Remarks** If the shape is in the shape or in the group , UpperLeftRow will be ignored. **Example** ``` if (shape.getUpperLeftRow() == 3) shape.setUpperLeftRow(1); ``` **Returns:** int ### getWidth() {#getWidth--} ``` public int getWidth() ``` Represents the width of shape, in unit of pixels. **Example** ``` if (shape.getWidth() == 3) shape.setWidth(1); ``` **Returns:** int ### getWidthCM() {#getWidthCM--} ``` public double getWidthCM() ``` Represents the width of the shape, in unit of centimeters. **Example** ``` if (shape.getWidthCM() == 3) shape.setWidthCM(1); ``` **Returns:** double ### getWidthInShape() {#getWidthInShape--} ``` public int getWidthInShape() ``` Represents the width of the shape, in unit of 1/4000 of the parent shape. **Remarks** Only Applies when this shape in the group or chart. **Example** ``` if (shape.isInGroup() &&shape.getWidthInShape() == 2000) shape.setWidthInShape(4000); ``` **Returns:** int ### getWidthInch() {#getWidthInch--} ``` public double getWidthInch() ``` Represents the width of the shape, in unit of inch. **Example** ``` if (shape.getWidthInch() == 3) shape.setWidthInch(1); ``` **Returns:** double ### getWidthPt() {#getWidthPt--} ``` public double getWidthPt() ``` Represents the width of the shape, in unit of point. **Example** ``` if (shape.getWidthPt() == 3) shape.setWidthPt(1); ``` **Returns:** double ### getWidthScale() {#getWidthScale--} ``` public int getWidthScale() ``` Gets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100; **Example** ``` if (shape.getWidthScale() == 3) shape.setWidthScale(1); ``` **Returns:** int ### getWorksheet() {#getWorksheet--} ``` public Worksheet getWorksheet() ``` Gets the [Worksheet](../../com.aspose.cells/worksheet) object which contains this shape. **Example** ``` Worksheet worksheet = shape.getWorksheet(); ``` **Returns:** [Worksheet](../../com.aspose.cells/worksheet) ### getX() {#getX--} ``` public int getX() ``` Gets the horizontal offset of shape from worksheet left border,in unit of pixels. **Example** ``` if (shape.getX() == 3) shape.setX(1); ``` **Returns:** int ### getY() {#getY--} ``` public int getY() ``` Gets the vertical offset of shape from worksheet top border,in unit of pixels. **Example** ``` if (shape.getY() == 3) shape.setY(1); ``` **Returns:** int ### getZOrderPosition() {#getZOrderPosition--} ``` public int getZOrderPosition() ``` Returns the position of a shape in the z-order. **Example** ``` shape.setZOrderPosition(3); ``` **Returns:** int ### hasLine() {#hasLine--} ``` public boolean hasLine() ``` Gets the line border of the shape is visible. **Example** ``` if(shape.hasLine() == false) shape.setHasLine(true); ``` **Returns:** boolean ### hashCode() {#hashCode--} ``` public native int hashCode() ``` **Returns:** int ### isAspectRatioLocked() {#isAspectRatioLocked--} ``` public boolean isAspectRatioLocked() ``` True means that aspect ratio of the shape is locked. **Remarks** Only for pictures and Ole Objects. **Example** ``` shape.setAspectRatioLocked(false); ``` **Returns:** boolean ### isDecorative() {#isDecorative--} ``` public boolean isDecorative() ``` Indicates whether the object is decorative. **Example** ``` if (!shape.isDecorative()) shape.setDecorative(true); ``` **Returns:** boolean ### isEquation() {#isEquation--} ``` public boolean isEquation() ``` Indicates whether the shape only contains an equation. **Example** ``` //If true,the shape only contains an equation. if(shape.isEquation()) { //The shape contains only an equation } ``` **Returns:** boolean ### isFilled() {#isFilled--} ``` public boolean isFilled() ``` Indicates whether the fill format is visible. **Example** ``` if(shape.isFilled() == false) shape.setFilled(true); ``` **Returns:** boolean ### isFlippedHorizontally() {#isFlippedHorizontally--} ``` public boolean isFlippedHorizontally() ``` Gets whether shape is horizontally flipped . **Example** ``` if(shape.isFlippedHorizontally() == false) shape.setFlippedHorizontally(true); ``` **Returns:** boolean ### isFlippedVertically() {#isFlippedVertically--} ``` public boolean isFlippedVertically() ``` Gets whether shape is vertically flipped . **Example** ``` if(shape.isFlippedVertically() == false) shape.setFlippedVertically(true); ``` **Returns:** boolean ### isGroup() {#isGroup--} ``` public boolean isGroup() ``` Indicates whether this shape is a group shape. **Example** ``` if(shape.isGroup()) { //This shape is a group. } ``` **Returns:** boolean ### isHidden() {#isHidden--} ``` public boolean isHidden() ``` Indicates whether the object is visible. **Example** ``` shape.setHidden(false); ``` **Returns:** boolean ### isInGroup() {#isInGroup--} ``` public boolean isInGroup() ``` Indicates whether the shape is grouped. **Returns:** boolean ### isLockAspectRatio() {#isLockAspectRatio--} ``` public boolean isLockAspectRatio() ``` True means that aspect ratio of the shape is locked. **Remarks** 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. **Example** ``` shape.setHidden(false); ``` **Returns:** boolean ### isLocked() {#isLocked--} ``` public boolean isLocked() ``` 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. **Example** ``` //Sets the specified shape to unlocked state if (shape.getWorksheet().isProtected() &&shape.isLocked()) { shape.setLocked(false); } //Sets the specified shape to a locked state if (shape.getWorksheet().isProtected() &&!shape.isLocked()) { shape.setLocked(true); } ``` **Returns:** boolean ### isPrintable() {#isPrintable--} ``` public boolean isPrintable() ``` Indicates whether the object is printable. If False, this shape will not be printed when printing. **Example** ``` if(shape.isPrintable()) shape.setPrintable(false); ``` **Returns:** boolean ### isRichText() {#isRichText--} ``` public boolean isRichText() ``` Whether or not the text is rich text. **Example** ``` if(shape.isRichText()) System.out.println("The text is rich text."); ``` **Returns:** boolean ### isSameSetting(Object obj) {#isSameSetting-java.lang.Object-} ``` public boolean isSameSetting(Object obj) ``` Returns whether the shape is same. **Example** ``` if (shape.isSameSetting(shape)) System.out.println("Two objects the same."); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | obj | java.lang.Object | | **Returns:** boolean - ### isSmartArt() {#isSmartArt--} ``` public boolean isSmartArt() ``` Indicates whether the shape is a smart art. **Remarks** Only for ooxml file. **Example** ``` //if true,the shape is a smart art. if(shape.isSmartArt()) { //The shape is SmartArt object. } ``` **Returns:** boolean ### isTextWrapped() {#isTextWrapped--} ``` public boolean isTextWrapped() ``` Gets the text wrapped type of the shape which contains text. **Example** ``` if (shape.isTextWrapped()) shape.setTextWrapped(!shape.isTextWrapped()); ``` **Returns:** boolean ### isWordArt() {#isWordArt--} ``` public boolean isWordArt() ``` Indicates whether this shape is a word art. **Remarks** Only for the Legacy Shape of xls file. **Example** ``` if(shape.isWordArt()) { //This shape is a WordArt object. } ``` **Returns:** boolean ### moveToRange(int topRow, int leftColumn, int bottomRow, int rightColumn) {#moveToRange-int-int-int-int-} ``` public void moveToRange(int topRow, int leftColumn, int bottomRow, int rightColumn) ``` Moves the shape to a specified range. **Example** ``` shape.moveToRange(12, 3, 13, 5); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | topRow | int | Upper left row index. | | leftColumn | int | Upper left column index. | | bottomRow | int | Lower right row index | | rightColumn | int | Lower right column index | ### notify() {#notify--} ``` public final native void notify() ``` ### notifyAll() {#notifyAll--} ``` public final native void notifyAll() ``` ### removeActiveXControl() {#removeActiveXControl--} ``` public void removeActiveXControl() ``` Remove activeX control. **Example** ``` if(shape.getActiveXControl() != null) { shape.removeActiveXControl(); } ``` ### removeHyperlink() {#removeHyperlink--} ``` public void removeHyperlink() ``` Removes the hyperlink of the shape. **Example** ``` shape.removeHyperlink(); ``` ### setAlternativeText(String value) {#setAlternativeText-java.lang.String-} ``` public void setAlternativeText(String value) ``` Returns or sets the descriptive (alternative) text string of the [Shape](../../com.aspose.cells/shape) object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setAnchorType(int value) {#setAnchorType-int-} ``` public void setAnchorType(int value) ``` Sets the type of the shape anchor placeholder. See [ShapeAnchorType](../../com.aspose.cells/shapeanchortype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setAspectRatioLocked(boolean value) {#setAspectRatioLocked-boolean-} ``` public void setAspectRatioLocked(boolean value) ``` True means that aspect ratio of the shape is locked. **Remarks** Only for pictures and Ole Objects. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setAutoShapeType(int value) {#setAutoShapeType-int-} ``` public void setAutoShapeType(int value) ``` Sets the auto shape type. See [AutoShapeType](../../com.aspose.cells/autoshapetype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setBottom(int value) {#setBottom-int-} ``` public void setBottom(int value) ``` Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setCreateId(UUID value) {#setCreateId-java.util.UUID-} ``` public void setCreateId(UUID value) ``` Sets create id for this shape. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.util.UUID | | ### setDecorative(boolean value) {#setDecorative-boolean-} ``` public void setDecorative(boolean value) ``` Indicates whether the object is decorative. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setFilled(boolean value) {#setFilled-boolean-} ``` public void setFilled(boolean value) ``` Indicates whether the fill format is visible. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setFlippedHorizontally(boolean value) {#setFlippedHorizontally-boolean-} ``` public void setFlippedHorizontally(boolean value) ``` Sets whether shape is horizontally flipped . **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setFlippedVertically(boolean value) {#setFlippedVertically-boolean-} ``` public void setFlippedVertically(boolean value) ``` Sets whether shape is vertically flipped . **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setFont(Font value) {#setFont-com.aspose.cells.Font-} ``` public void setFont(Font value) ``` Represents the font of shape. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | [Font](../../com.aspose.cells/font) | | ### setHasLine(boolean value) {#setHasLine-boolean-} ``` public void setHasLine(boolean value) ``` Sets the line border of the shape is visible. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setHeight(int value) {#setHeight-int-} ``` public void setHeight(int value) ``` Represents the height of shape, in unit of pixel. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setHeightCM(double value) {#setHeightCM-double-} ``` public void setHeightCM(double value) ``` Represents the height of the shape, in unit of centimeters. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setHeightInShape(int value) {#setHeightInShape-int-} ``` public void setHeightInShape(int 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.. **Remarks** Only Applies when this shape in the group or chart. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setHeightInch(double value) {#setHeightInch-double-} ``` public void setHeightInch(double value) ``` Represents the height of the shape, in unit of inches. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setHeightPt(double value) {#setHeightPt-double-} ``` public void setHeightPt(double value) ``` Represents the height of the shape, in unit of points. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setHeightScale(int value) {#setHeightScale-int-} ``` public void setHeightScale(int value) ``` 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; **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setHidden(boolean value) {#setHidden-boolean-} ``` public void setHidden(boolean value) ``` Indicates whether the object is visible. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setHtmlText(String value) {#setHtmlText-java.lang.String-} ``` public void setHtmlText(String value) ``` Sets the html string which contains data and some formats in this textbox. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setInputRange(String value) {#setInputRange-java.lang.String-} ``` public void setInputRange(String value) ``` Sets the worksheet range used to fill the specified combo box. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setInputRange(String formula, boolean isR1C1, boolean isLocal) {#setInputRange-java.lang.String-boolean-boolean-} ``` public void setInputRange(String formula, boolean isR1C1, boolean isLocal) ``` Sets the range used to fill the control. **Example** ``` //After executing the code below, a ListBox object is created in the generated file. When the selected option is clicked, the selected value is displayed in cell A12. for (int i = 0; i? ++i) { Cell cell = book.getWorksheets().get(0).getCells().get(i, 0); cell.setValue(i + 1); } //Create a ListBox object //ActiveX Controls //Aspose.Cells.Drawing.Shape listBox = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ListBox,2, 0, 2, 0, 130, 130); //Form Controls Shape listBox = book.getWorksheets().get(0).getShapes().addListBox(2, 0, 2, 0, 130, 130); //Sets the range used to fill the control. listBox.setInputRange("$A$1:$A$6", false, false); //Sets the range linked to the control's value. listBox.setLinkedCell("$A$12", false, true); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | formula | java.lang.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. | ### setLeft(int value) {#setLeft-int-} ``` public void setLeft(int value) ``` Represents the horizontal offset of shape from its left column, in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setLeftCM(double value) {#setLeftCM-double-} ``` public void setLeftCM(double value) ``` Represents the horizontal offset of shape from its left column, in unit of centimeters. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setLeftInShape(int value) {#setLeftInShape-int-} ``` public void setLeftInShape(int 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. **Remarks** Only Applies when this shape in the group or chart. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setLeftInch(double value) {#setLeftInch-double-} ``` public void setLeftInch(double value) ``` Represents the horizontal offset of shape from its left column, in unit of inches. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setLeftToCorner(int value) {#setLeftToCorner-int-} ``` public void setLeftToCorner(int value) ``` Sets the horizonal offset of shape from worksheet left border. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setLinkedCell(String value) {#setLinkedCell-java.lang.String-} ``` public void setLinkedCell(String value) ``` Sets the worksheet range linked to the control's value. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setLinkedCell(String formula, boolean isR1C1, boolean isLocal) {#setLinkedCell-java.lang.String-boolean-boolean-} ``` public void setLinkedCell(String formula, boolean isR1C1, boolean isLocal) ``` Sets the range linked to the control's value. **Example** ``` //After executing the code below, a ScrollBar object is created in the generated file. As you drag the slider, the value is displayed in cell A12. //ActiveX Controls //Aspose.Cells.Drawing.Shape scrollBar = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ScrollBar,2, 0, 2, 0, 30, 130); //Form Controls Shape scrollBar = book.getWorksheets().get(0).getShapes().addScrollBar(2, 0, 2, 0, 130, 30); //Sets the range linked to the control's value. scrollBar.setLinkedCell("$A$12", false, true); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | formula | java.lang.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. | ### setLockAspectRatio(boolean value) {#setLockAspectRatio-boolean-} ``` public void setLockAspectRatio(boolean value) ``` True means that aspect ratio of the shape is locked. **Remarks** 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. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setLocked(boolean value) {#setLocked-boolean-} ``` public void setLocked(boolean 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. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setLockedProperty(int type, boolean value) {#setLockedProperty-int-boolean-} ``` public void setLockedProperty(int type, boolean value) ``` Set the locked property. **Example** ``` shape.setLockedProperty(ShapeLockType.ADJUST_HANDLES, true); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | type | int | [ShapeLockType](../../com.aspose.cells/shapelocktype). The locked type. | | value | boolean | The value of the property. | ### setLowerDeltaX(int value) {#setLowerDeltaX-int-} ``` public void setLowerDeltaX(int value) ``` Sets the shape's horizontal offset from its lower right corner column. **Remarks** The range of value is 0 to 1024. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setLowerDeltaY(int value) {#setLowerDeltaY-int-} ``` public void setLowerDeltaY(int value) ``` Sets the shape's vertical offset from its lower right corner row. **Remarks** The range of value is 0 to 256. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setLowerRightColumn(int value) {#setLowerRightColumn-int-} ``` public void setLowerRightColumn(int value) ``` Represents lower right corner column index. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setLowerRightRow(int value) {#setLowerRightRow-int-} ``` public void setLowerRightRow(int value) ``` Represents lower right corner row index. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setMacroName(String value) {#setMacroName-java.lang.String-} ``` public void setMacroName(String value) ``` Sets the name of macro. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setName(String value) {#setName-java.lang.String-} ``` public void setName(String value) ``` Sets the name of the shape. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setPlacement(int value) {#setPlacement-int-} ``` public void setPlacement(int 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. See [PlacementType](../../com.aspose.cells/placementtype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setPrintable(boolean value) {#setPrintable-boolean-} ``` public void setPrintable(boolean value) ``` Indicates whether the object is printable. If False, this shape will not be printed when printing. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setRelativeToOriginalPictureSize(boolean value) {#setRelativeToOriginalPictureSize-boolean-} ``` public void setRelativeToOriginalPictureSize(boolean value) ``` Indicates whether shape is relative to original picture size. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setRight(int value) {#setRight-int-} ``` public void setRight(int value) ``` Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setRotationAngle(double value) {#setRotationAngle-double-} ``` public void setRotationAngle(double value) ``` Sets the rotation of the shape. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setSoftEdges(double value) {#setSoftEdges-double-} ``` public void setSoftEdges(double value) ``` Sets the radius of blur to apply to the edges, in unit of points. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setText(String value) {#setText-java.lang.String-} ``` public void setText(String value) ``` Sets the text of this shape. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setTextDirection(int value) {#setTextDirection-int-} ``` public void setTextDirection(int value) ``` Sets the direction of the text flow for this object. See [TextDirectionType](../../com.aspose.cells/textdirectiontype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextHorizontalAlignment(int value) {#setTextHorizontalAlignment-int-} ``` public void setTextHorizontalAlignment(int value) ``` Sets the text horizontal alignment type of the shape. See [TextAlignmentType](../../com.aspose.cells/textalignmenttype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextHorizontalOverflow(int value) {#setTextHorizontalOverflow-int-} ``` public void setTextHorizontalOverflow(int value) ``` Sets the text horizontal overflow type of the shape which contains text. See [TextOverflowType](../../com.aspose.cells/textoverflowtype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextOptions(TextOptions value) {#setTextOptions-com.aspose.cells.TextOptions-} ``` public void setTextOptions(TextOptions value) ``` Represents the text options of the shape. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | [TextOptions](../../com.aspose.cells/textoptions) | | ### setTextOrientationType(int value) {#setTextOrientationType-int-} ``` public void setTextOrientationType(int value) ``` Sets the text orientation type of the shape. See [TextOrientationType](../../com.aspose.cells/textorientationtype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextShapeType(int value) {#setTextShapeType-int-} ``` public void setTextShapeType(int value) ``` Sets the preset text shape type. See [AutoShapeType](../../com.aspose.cells/autoshapetype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextVerticalAlignment(int value) {#setTextVerticalAlignment-int-} ``` public void setTextVerticalAlignment(int value) ``` Sets the text vertical alignment type of the shape. See [TextAlignmentType](../../com.aspose.cells/textalignmenttype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextVerticalOverflow(int value) {#setTextVerticalOverflow-int-} ``` public void setTextVerticalOverflow(int value) ``` Sets the text vertical overflow type of the shape which contains text. See [TextOverflowType](../../com.aspose.cells/textoverflowtype). **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTextWrapped(boolean value) {#setTextWrapped-boolean-} ``` public void setTextWrapped(boolean value) ``` Sets the text wrapped type of the shape which contains text. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | | ### setTitle(String value) {#setTitle-java.lang.String-} ``` public void setTitle(String value) ``` Specifies the title (caption) of the current shape object. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | | ### setTop(int value) {#setTop-int-} ``` public void setTop(int value) ``` Represents the vertical offset of shape from its top row, in unit of pixels. **Remarks** If the shape is in the chart, represents the vertical offset of shape from its top border. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTopCM(double value) {#setTopCM-double-} ``` public void setTopCM(double value) ``` Represents the vertical offset of shape from its top row, in unit of centimeters. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setTopInShape(int value) {#setTopInShape-int-} ``` public void setTopInShape(int 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. **Remarks** Only Applies when this shape in the group or chart. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setTopInch(double value) {#setTopInch-double-} ``` public void setTopInch(double value) ``` Represents the vertical offset of shape from its top row, in unit of inches. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setTopToCorner(int value) {#setTopToCorner-int-} ``` public void setTopToCorner(int value) ``` Sets the vertical offset of shape from worksheet top border, in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setUpperDeltaX(int value) {#setUpperDeltaX-int-} ``` public void setUpperDeltaX(int value) ``` Sets the shape's horizontal offset from its upper left corner column. **Remarks** The range of value is 0 to 1024. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setUpperDeltaY(int value) {#setUpperDeltaY-int-} ``` public void setUpperDeltaY(int value) ``` Sets the shape's vertical offset from its upper left corner row. **Remarks** The range of value is 0 to 256. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setUpperLeftColumn(int value) {#setUpperLeftColumn-int-} ``` public void setUpperLeftColumn(int value) ``` Represents upper left corner column index. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setUpperLeftRow(int value) {#setUpperLeftRow-int-} ``` public void setUpperLeftRow(int value) ``` Represents the top row index. **Remarks** If the shape is in the shape or in the group , UpperLeftRow will be ignored. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setWidth(int value) {#setWidth-int-} ``` public void setWidth(int value) ``` Represents the width of shape, in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setWidthCM(double value) {#setWidthCM-double-} ``` public void setWidthCM(double value) ``` Represents the width of the shape, in unit of centimeters. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setWidthInShape(int value) {#setWidthInShape-int-} ``` public void setWidthInShape(int value) ``` Represents the width of the shape, in unit of 1/4000 of the parent shape. **Remarks** Only Applies when this shape in the group or chart. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setWidthInch(double value) {#setWidthInch-double-} ``` public void setWidthInch(double value) ``` Represents the width of the shape, in unit of inch. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setWidthPt(double value) {#setWidthPt-double-} ``` public void setWidthPt(double value) ``` Represents the width of the shape, in unit of point. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | | ### setWidthScale(int value) {#setWidthScale-int-} ``` public void setWidthScale(int value) ``` 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; **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setX(int value) {#setX-int-} ``` public void setX(int value) ``` Sets the horizontal offset of shape from worksheet left border,in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setY(int value) {#setY-int-} ``` public void setY(int value) ``` Sets the vertical offset of shape from worksheet top border,in unit of pixels. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### setZOrderPosition(int value) {#setZOrderPosition-int-} ``` public void setZOrderPosition(int value) ``` Returns the position of a shape in the z-order. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | | ### toFrontOrBack(int orders) {#toFrontOrBack-int-} ``` public void toFrontOrBack(int orders) ``` Brings the shape to the front or sends the shape to back. **Example** ``` shape.toFrontOrBack(2); //or shape.ToFrontOrBack(-1); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | orders | int | If it's less than zero, sets the shape to back. If it's greater than zero, brings the shape to front. | ### toImage(OutputStream stream, ImageFormat imageFormat) {#toImage-java.io.OutputStream-com.aspose.cells.ImageFormat-} ``` public void toImage(OutputStream stream, ImageFormat imageFormat) ``` Creates the shape image and saves it to a stream in the specified format. **Remarks** The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | stream | java.io.OutputStream | The output stream. | | imageFormat | [ImageFormat](../../com.aspose.cells/imageformat) | The format in which to save the image. | ### toImage(OutputStream stream, ImageOrPrintOptions options) {#toImage-java.io.OutputStream-com.aspose.cells.ImageOrPrintOptions-} ``` public void toImage(OutputStream stream, ImageOrPrintOptions options) ``` Saves the shape to a stream. **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | stream | java.io.OutputStream | | | options | [ImageOrPrintOptions](../../com.aspose.cells/imageorprintoptions) | | ### toImage(String imageFile, ImageOrPrintOptions options) {#toImage-java.lang.String-com.aspose.cells.ImageOrPrintOptions-} ``` public void toImage(String imageFile, ImageOrPrintOptions options) ``` Saves the shape to a file. **Example** ``` ImageOrPrintOptions op = new ImageOrPrintOptions(); shape.toImage("exmaple.png", op); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | imageFile | java.lang.String | | | options | [ImageOrPrintOptions](../../com.aspose.cells/imageorprintoptions) | | ### toString() {#toString--} ``` public String toString() ``` **Returns:** java.lang.String ### updateSelectedValue() {#updateSelectedValue--} ``` public void updateSelectedValue() ``` Update the selected value by the value of the linked cell. **Example** ``` Cell cell = null; for (int i = 0; i? ++i) { cell = book.getWorksheets().get(0).getCells().get(i, 0); cell.setValue(i + 1); } //Create a ListBox object //ActiveX Controls //Aspose.Cells.Drawing.Shape listBox = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ListBox,2, 0, 2, 0, 130, 130); //Form Controls Shape listBox = book.getWorksheets().get(0).getShapes().addListBox(2, 0, 2, 0, 130, 130); //Sets the range used to fill the control. listBox.setInputRange("$A$1:$A$6", false, false); //Sets the range linked to the control's value. listBox.setLinkedCell("$A$12", false, true); ListBox listbx = (ListBox)listBox; //Set the value of cell A12 cell = book.getWorksheets().get(0).getCells().get(11, 0); cell.setValue(3); //Update the selected value by the value of the linked cell. listBox.updateSelectedValue(); //-1 default, no option selected if(listbx.isSelected(2)) { //Option 3 of the ListBox is selected } //Change the value of a linked cell cell.setValue(4); //Update the selected value by the value of the linked cell. listBox.updateSelectedValue(); if(listbx.isSelected(3)) { //Option 4 of the ListBox is selected } ``` ### wait() {#wait--} ``` public final void wait() ``` ### wait(long arg0) {#wait-long-} ``` public final native void wait(long arg0) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | arg0 | long | | ### wait(long arg0, int arg1) {#wait-long-int-} ``` public final void wait(long arg0, int arg1) ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | arg0 | long | | | arg1 | int | |