All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspose.cells.ListBox.html Maven / Gradle / Ivy

There is a newer version: 23.1
Show newest version





ListBox




com.aspose.cells
Class ListBox

java.lang.Object
  extended by Shape
      extended by com.aspose.cells.ListBox

public class ListBox 
extends Shape

Represents a list box object.

Example:

//Create a new Workbook.
Workbook workbook = new Workbook();

//Get the first worksheet.
Worksheet sheet = workbook.getWorksheets().get(0);

//Get the worksheet cells collection.
Cells cells = sheet.getCells();

//Input a value.
cells.get("B3").putValue("Choose Dept:");

//Set it bold.
Cell cell = cells.get("B3");
Style style = cell.getStyle();
style.getFont().setBold(true);
cell.setStyle(style);

//Input some values that denote the input range
//for the list box.
cells.get("A2").putValue("Sales");
cells.get("A3").putValue("Finance");
cells.get("A4").putValue("MIS");
cells.get("A5").putValue("R&D");
cells.get("A6").putValue("Marketing");
cells.get("A7").putValue("HRA");

//Add a new list box.
ListBox listBox = (ListBox)sheet.getShapes().addShape(MsoDrawingType.LIST_BOX, 2, 0, 3, 0, 122, 100);

//Set the placement type.
listBox.setPlacement(PlacementType.FREE_FLOATING);

//Set the linked cell.
listBox.setLinkedCell("A1");

//Set the input range.
listBox.setInputRange("A2:A7");

//Set the selection tyle.
listBox.setSelectionType(SelectionType.SINGLE);

//Set the list box with 3-D shading.
listBox.setShadow(true);

//Saves the file.
workbook.save("d:\\test\\tstlistbox.xls");


Property Getters/Setters Summary
ActiveXControlgetActiveXControl()→ inherited from Shape
           Gets the ActiveX control.
intgetActualLowerRightRow()→ inherited from Shape
           Get the actual bottom row.
java.lang.StringgetAlternativeText()→ inherited from Shape
voidsetAlternativeText(java.lang.String)
           Returns or sets the descriptive (alternative) text string of the Shape object.
intgetAnchorType()→ inherited from Shape
voidsetAnchorType(int)
           Gets and set the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
intgetAutoShapeType()→ inherited from Shape
voidsetAutoShapeType(int)
           Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
intgetBottom()→ inherited from Shape
voidsetBottom(int)
           Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
java.awt.geom.Point2D.Float[]getConnectionPoints()→ inherited from Shape
           Get the connection points
byte[]getControlData()→ inherited from Shape
           Gets the data of control.
FillFormatgetFill()→ inherited from Shape
           Returns a FillFormat object that contains fill formatting properties for the specified shape.
MsoFillFormatgetFillFormat()→ inherited from Shape
           Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
FontgetFont()→ inherited from Shape
voidsetFont(Font)
           Represents the font of shape.
ShapeFormatgetFormat()→ inherited from Shape
           Represents the setting of the shape's formatting.
MsoFormatPicturegetFormatPicture()→ inherited from Shape
           Gets and sets the options of the picture format.
GeometrygetGeometry()→ inherited from Shape
           Gets the geometry
GlowEffectgetGlow()→ inherited from Shape
           Represents a object that specifies glow effect for the chart element or shape.
GroupShapegetGroup()→ inherited from Shape
           Gets the group shape which contains this shape.
booleanhasLine()→ inherited from Shape
voidsetHasLine(boolean)
           Gets and sets the line border of the shape is visible.
intgetHeight()→ inherited from Shape
voidsetHeight(int)
           Represents the height of shape, in unit of pixel.
doublegetHeightCM()→ inherited from Shape
voidsetHeightCM(double)
           Represents the height of the shape, in unit of centimeters.
doublegetHeightInch()→ inherited from Shape
voidsetHeightInch(double)
           Represents the height of the shape, in unit of inches.
intgetHeightInChart()→ inherited from Shape
voidsetHeightInChart(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..
intgetHeightInShape()→ inherited from Shape
voidsetHeightInShape(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..
doublegetHeightPt()→ inherited from Shape
voidsetHeightPt(double)
           Represents the height of the shape, in unit of points.
intgetHeightScale()→ inherited from Shape
voidsetHeightScale(int)
           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;
java.lang.StringgetHtmlText()→ inherited from Shape
voidsetHtmlText(java.lang.String)
           Gets and sets the html string which contains data and some formats in this textbox.
HyperlinkgetHyperlink()→ inherited from Shape
           Gets the hyperlink of the shape.
intgetId()→ inherited from Shape
           Gets the identifier of this shape.
java.lang.StringgetInputRange()→ inherited from Shape
voidsetInputRange(java.lang.String)
           Gets or sets the worksheet range used to fill the specified combo box.
booleanisEquation()→ inherited from Shape
           Indicates whether the shape only contains an equation.
booleanisFilled()→ inherited from Shape
voidsetFilled(boolean)
           Indicates whether the fill format is visible.
booleanisFlippedHorizontally()→ inherited from Shape
voidsetFlippedHorizontally(boolean)
           Gets and sets whether shape is horizontally flipped .
booleanisFlippedVertically()→ inherited from Shape
voidsetFlippedVertically(boolean)
           Gets and sets whether shape is vertically flipped .
booleanisGroup()→ inherited from Shape
           Indicates whether the shape is a group.
booleanisHidden()→ inherited from Shape
voidsetHidden(boolean)
           Indicates whether the object is visible.
booleanisInGroup()→ inherited from Shape
           Indicates whether the shape is grouped.
booleanisLockAspectRatio()→ inherited from Shape
voidsetLockAspectRatio(boolean)
           True means that don't allow changes in aspect ratio.
booleanisLocked()→ inherited from Shape
voidsetLocked(boolean)
           True if the object is locked, False if the object can be modified when the sheet is protected.
booleanisPrintable()→ inherited from Shape
voidsetPrintable(boolean)
           True if the object is printable
booleanisRichText()→ inherited from Shape
           Whether or not the text is rich text.
booleanisSmartArt()→ inherited from Shape
           Indicates whether the shape is smart art.
booleanisTextWrapped()→ inherited from Shape
voidsetTextWrapped(boolean)
           Gets and sets the text wrapped type of the shape which contains text.
booleanisWordArt()→ inherited from Shape
           Indicates whether this shape is a word art.
intgetItemCount()
           Gets the number of items in the list box.
intgetLeft()→ inherited from Shape
voidsetLeft(int)
           Represents the horizontal offset of shape from its left column, in unit of pixels.
doublegetLeftCM()→ inherited from Shape
voidsetLeftCM(double)
           Represents the horizontal offset of shape from its left column, in unit of centimeters.
doublegetLeftInch()→ inherited from Shape
voidsetLeftInch(double)
           Represents the horizontal offset of shape from its left column, in unit of inches.
intgetLeftInChart()→ inherited from Shape
voidsetLeftInChart(int)
           Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
intgetLeftInShape()→ inherited from Shape
voidsetLeftInShape(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.
intgetLeftToCorner()→ inherited from Shape
voidsetLeftToCorner(int)
           Gets and sets the horizonal offset of shape from worksheet left border.
LineFormatgetLine()→ inherited from Shape
           Gets line style
MsoLineFormatgetLineFormat()→ inherited from Shape
           Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
java.lang.StringgetLinkedCell()→ inherited from Shape
voidsetLinkedCell(java.lang.String)
           Gets or sets the worksheet range linked to the control's value.
intgetLowerDeltaX()→ inherited from Shape
voidsetLowerDeltaX(int)
           Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.
intgetLowerDeltaY()→ inherited from Shape
voidsetLowerDeltaY(int)
           Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.
intgetLowerRightColumn()→ inherited from Shape
voidsetLowerRightColumn(int)
           Represents lower right corner column index.
intgetLowerRightRow()→ inherited from Shape
voidsetLowerRightRow(int)
           Represents lower right corner row index.
java.lang.StringgetMacroName()→ inherited from Shape
voidsetMacroName(java.lang.String)
           Gets and sets the name of macro.
intgetMsoDrawingType()→ inherited from Shape
           Gets mso drawing type. The value of the property is MsoDrawingType integer constant.
java.lang.StringgetName()→ inherited from Shape
voidsetName(java.lang.String)
           Gets and sets the name of the shape.
intgetPageChange()
voidsetPageChange(int)
           Specifies the amount by which the control's value is changed when the user clicks on the scrollbar's page up or page down region.
ShapePathCollectiongetPaths()→ inherited from Shape
           Gets the paths of a custom geometric shape.
intgetPlacement()→ inherited from Shape
voidsetPlacement(int)
           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.
intgetPositionX()→ inherited from Shape
voidsetPositionX(int)
           Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
intgetPositionY()→ inherited from Shape
voidsetPositionY(int)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
ReflectionEffectgetReflection()→ inherited from Shape
           Represents a object that specifies reflection effect for the chart element or shape.
booleangetRelativeToOriginalPictureSize()→ inherited from Shape
voidsetRelativeToOriginalPictureSize(boolean)
           Indicates whether shape is relative to original picture size.
intgetRight()→ inherited from Shape
voidsetRight(int)
           Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
doublegetRotationAngle()→ inherited from Shape
voidsetRotationAngle(double)
           Gets and sets the rotation of the shape.
com.aspose.cells.Cell[]getSelectedCells()
           Gets the selected cells. Returns null if the input range is not set or no item is selected
intgetSelectedIndex()
voidsetSelectedIndex(int)
           Gets or sets the index number of the currently selected item in a list box or combo box. Zero-based.
intgetSelectionType()
voidsetSelectionType(int)
           Gets or sets the selection mode of the specified list box. The value of the property is SelectionType integer constant.
booleangetShadow()
voidsetShadow(boolean)
           Indicates whether the combobox has 3-D shading.
ShadowEffectgetShadowEffect()→ inherited from Shape
           Represents a object that specifies shadow effect for the chart element or shape.
doublegetSoftEdges()→ inherited from Shape
voidsetSoftEdges(double)
           Gets and sets the radius of blur to apply to the edges, in unit of points.
java.lang.StringgetSpid()→ inherited from Shape
           Specifies an optional string that an application can use to Identify the particular shape.
intgetSpt()→ inherited from Shape
           Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
java.lang.StringgetText()→ inherited from Shape
voidsetText(java.lang.String)
           Represents the string in this TextBox object.
FontSettingCollectiongetTextBody()→ inherited from Shape
           Gets and sets the setting of the shape's text.
intgetTextDirection()→ inherited from Shape
voidsetTextDirection(int)
           Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
TextEffectFormatgetTextEffect()→ inherited from Shape
           Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
MsoTextFramegetTextFrame()→ inherited from Shape
           Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
intgetTextHorizontalAlignment()→ inherited from Shape
voidsetTextHorizontalAlignment(int)
           Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
intgetTextHorizontalOverflow()→ inherited from Shape
voidsetTextHorizontalOverflow(int)
           Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
TextOptionsgetTextOptions()→ inherited from Shape
voidsetTextOptions(TextOptions)
           Represents the text options of the shape.
intgetTextOrientationType()→ inherited from Shape
voidsetTextOrientationType(int)
           Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
intgetTextShapeType()→ inherited from Shape
voidsetTextShapeType(int)
           Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
intgetTextVerticalAlignment()→ inherited from Shape
voidsetTextVerticalAlignment(int)
           Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalOverflow()→ inherited from Shape
voidsetTextVerticalOverflow(int)
           Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
ThreeDFormatgetThreeDFormat()→ inherited from Shape
           Gets and sets 3d format of the shape.
java.lang.StringgetTitle()→ inherited from Shape
voidsetTitle(java.lang.String)
           Specifies the title (caption) of the current shape object.
intgetTop()→ inherited from Shape
voidsetTop(int)
           Represents the vertical offset of shape from its top row, in unit of pixels.
doublegetTopCM()→ inherited from Shape
voidsetTopCM(double)
           Represents the vertical offset of shape from its top row, in unit of centimeters.
doublegetTopInch()→ inherited from Shape
voidsetTopInch(double)
           Represents the vertical offset of shape from its top row, in unit of inches.
intgetTopInChart()→ inherited from Shape
voidsetTopInChart(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.
intgetTopInShape()→ inherited from Shape
voidsetTopInShape(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.
intgetTopToCorner()→ inherited from Shape
voidsetTopToCorner(int)
           Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
intgetType()→ inherited from Shape
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
intgetUpperDeltaX()→ inherited from Shape
voidsetUpperDeltaX(int)
           Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.
intgetUpperDeltaY()→ inherited from Shape
voidsetUpperDeltaY(int)
           Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.
intgetUpperLeftColumn()→ inherited from Shape
voidsetUpperLeftColumn(int)
           Represents upper left corner column index.
intgetUpperLeftRow()→ inherited from Shape
voidsetUpperLeftRow(int)
           Represents upper left corner row index.
intgetWidth()→ inherited from Shape
voidsetWidth(int)
           Represents the width of shape, in unit of pixels.
doublegetWidthCM()→ inherited from Shape
voidsetWidthCM(double)
           Represents the width of the shape, in unit of centimeters.
doublegetWidthInch()→ inherited from Shape
voidsetWidthInch(double)
           Represents the width of the shape, in unit of inch.
intgetWidthInChart()→ inherited from Shape
voidsetWidthInChart(int)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
intgetWidthInShape()→ inherited from Shape
voidsetWidthInShape(int)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
doublegetWidthPt()→ inherited from Shape
voidsetWidthPt(double)
           Represents the width of the shape, in unit of point.
intgetWidthScale()→ inherited from Shape
voidsetWidthScale(int)
           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;
WorksheetgetWorksheet()→ inherited from Shape
           Gets the Worksheet object which contains this shape.
intgetX()→ inherited from Shape
voidsetX(int)
           Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
intgetY()→ inherited from Shape
voidsetY(int)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
intgetZOrderPosition()→ inherited from Shape
voidsetZOrderPosition(int)
           Returns the position of a shape in the z-order.
 
Method Summary
HyperlinkaddHyperlink(java.lang.String address)→ inherited from Shape
           Adds a hyperlink to the shape.
voidalignTopRightCorner(int topRow, int rightColumn)→ inherited from Shape
           Moves the picture to the top-right corner.
int[]calculateTextSize()→ inherited from Shape
           Recalculate the text area
FontSettingcharacters(int startIndex, int length)→ inherited from Shape
           Returns a Characters object that represents a range of characters within the text.
voidformatCharacters(int startIndex, int length, Font font)→ inherited from Shape
           Formats some characters with the font setting.
voidformatCharacters(int startIndex, int length, Font font, StyleFlag flag)→ inherited from Shape
           Formats some characters with the font setting.
java.util.ArrayListgetCharacters()→ inherited from Shape
           Returns all Characters objects that represents a range of characters within the text .
float[][]getConnectionPoints()→ inherited from Shape
           Get the connection points
java.lang.StringgetInputRange(boolean isR1C1, boolean isLocal)→ inherited from Shape
           Gets the range used to fill the control.
java.lang.StringgetLinkedCell(boolean isR1C1, boolean isLocal)→ inherited from Shape
           Gets the range linked to the control's value.
booleangetLockedProperty(int type)→ inherited from Shape
           Gets the value of locked property.
GroupShapegetResultOfSmartArt()→ inherited from Shape
           Converting smart art to grouped shapes.
booleanisSameSetting(java.lang.Object obj)→ inherited from Shape
           Returns whether the shape is same.
booleanisSelected(int itemIndex)
           Indicates whether the item is selected.
voidmoveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)→ inherited from Shape
           Moves the shape to a specified range.
voidremoveActiveXControl()→ inherited from Shape
           Remove activeX control.
voidremoveHyperlink()→ inherited from Shape
           Remove the hyperlink of the shape.
voidselectedItem(int itemIndex, boolean isSelected)
           Sets whether the item is selected
voidsetInputRange(java.lang.String formula, boolean isR1C1, boolean isLocal)→ inherited from Shape
           Sets the range used to fill the control.
voidsetLinkedCell(java.lang.String formula, boolean isR1C1, boolean isLocal)→ inherited from Shape
           Sets the range linked to the control's value.
voidsetLockedProperty(int type, boolean value)→ inherited from Shape
           Set the locked property.
voidtoFrontOrBack(int orders)→ inherited from Shape
           Brings the shape to the front or sends the shape to back.
voidtoImage(java.io.OutputStream stream, ImageFormat imageFormat)→ inherited from Shape
           Creates the shape image and saves it to a stream in the specified format.
voidtoImage(java.io.OutputStream stream, ImageOrPrintOptions options)→ inherited from Shape
           Saves the shape to a stream.
voidtoImage(java.lang.String imageFile, ImageOrPrintOptions options)→ inherited from Shape
           Saves the shape to a file.
voidupdateSelectedValue()→ inherited from Shape
           Update the selected value by the value of the linked cell.
 

Property Getters/Setters Detail

getItemCount

public int getItemCount()
Gets the number of items in the list box.

getSelectedIndex/setSelectedIndex

public int getSelectedIndex() / public void setSelectedIndex(int value)
Gets or sets the index number of the currently selected item in a list box or combo box. Zero-based. -1 presents no item is selected.

setSelectedIndex

public void setSelectedIndex(int value)
Gets or sets the index number of the currently selected item in a list box or combo box. Zero-based. -1 presents no item is selected.

getSelectedCells

public com.aspose.cells.Cell[] getSelectedCells()
Gets the selected cells. Returns null if the input range is not set or no item is selected

getShadow/setShadow

public boolean getShadow() / public void setShadow(boolean value)
Indicates whether the combobox has 3-D shading.

setShadow

public void setShadow(boolean value)
Indicates whether the combobox has 3-D shading.

getSelectionType/setSelectionType

public int getSelectionType() / public void setSelectionType(int value)
Gets or sets the selection mode of the specified list box. The value of the property is SelectionType integer constant.

setSelectionType

public void setSelectionType(int value)
Gets or sets the selection mode of the specified list box. The value of the property is SelectionType integer constant.

getPageChange/setPageChange

public int getPageChange() / public void setPageChange(int value)
Specifies the amount by which the control's value is changed when the user clicks on the scrollbar's page up or page down region.

setPageChange

public void setPageChange(int value)
Specifies the amount by which the control's value is changed when the user clicks on the scrollbar's page up or page down region.

getMacroName/setMacroName

→ inherited from Shape
public java.lang.String getMacroName() / public void setMacroName(java.lang.String value)
Gets and sets the name of macro.

setMacroName

→ inherited from Shape
public void setMacroName(java.lang.String value)
Gets and sets the name of macro.

isEquation

→ inherited from Shape
public boolean isEquation()
Indicates whether the shape only contains an equation.

isSmartArt

→ inherited from Shape
public boolean isSmartArt()
Indicates whether the shape is smart art. Only for ooxml file.

getZOrderPosition/setZOrderPosition

→ inherited from Shape
public int getZOrderPosition() / public void setZOrderPosition(int value)
Returns the position of a shape in the z-order.

setZOrderPosition

→ inherited from Shape
public void setZOrderPosition(int value)
Returns the position of a shape in the z-order.

getName/setName

→ inherited from Shape
public java.lang.String getName() / public void setName(java.lang.String value)
Gets and sets the name of the shape.

setName

→ inherited from Shape
public void setName(java.lang.String value)
Gets and sets the name of the shape.

getAlternativeText/setAlternativeText

→ inherited from Shape
public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
Returns or sets the descriptive (alternative) text string of the Shape object.

setAlternativeText

→ inherited from Shape
public void setAlternativeText(java.lang.String value)
Returns or sets the descriptive (alternative) text string of the Shape object.

getTitle/setTitle

→ inherited from Shape
public java.lang.String getTitle() / public void setTitle(java.lang.String value)
Specifies the title (caption) of the current shape object.

setTitle

→ inherited from Shape
public void setTitle(java.lang.String value)
Specifies the title (caption) of the current shape object.

getLineFormat

→ inherited from Shape
public MsoLineFormat getLineFormat()
Returns a MsoLineFormat object that contains line formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Line property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.

getFillFormat

→ inherited from Shape
public MsoFillFormat getFillFormat()
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Fill property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.

getFormat

→ inherited from Shape
public ShapeFormat getFormat()
Represents the setting of the shape's formatting. NOTE: This member is now obsolete. Instead, please use Shape.Fill and Shape.Line properties. This property will be removed 6 months later since August 2016. Aspose apologizes for any inconvenience you may have experienced.

getLine

→ inherited from Shape
public LineFormat getLine()
Gets line style

getFill

→ inherited from Shape
public FillFormat getFill()
Returns a FillFormat object that contains fill formatting properties for the specified shape.

getShadowEffect

→ inherited from Shape
public ShadowEffect getShadowEffect()
Represents a object that specifies shadow effect for the chart element or shape.
See Also:
ShadowEffect

getReflection

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

getGlow

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

getSoftEdges/setSoftEdges

→ inherited from Shape
public double getSoftEdges() / public void setSoftEdges(double value)
Gets and sets the radius of blur to apply to the edges, in unit of points.

setSoftEdges

→ inherited from Shape
public void setSoftEdges(double value)
Gets and sets the radius of blur to apply to the edges, in unit of points.

getThreeDFormat

→ inherited from Shape
public ThreeDFormat getThreeDFormat()
Gets and sets 3d format of the shape.

getTextFrame

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

getFormatPicture

→ inherited from Shape
public MsoFormatPicture getFormatPicture()
Gets and sets the options of the picture format.

isHidden/setHidden

→ inherited from Shape
public boolean isHidden() / public void setHidden(boolean value)
Indicates whether the object is visible.

setHidden

→ inherited from Shape
public void setHidden(boolean value)
Indicates whether the object is visible.

isLockAspectRatio/setLockAspectRatio

→ inherited from Shape
public boolean isLockAspectRatio() / public void setLockAspectRatio(boolean value)
True means that don't allow changes in aspect ratio.

setLockAspectRatio

→ inherited from Shape
public void setLockAspectRatio(boolean value)
True means that don't allow changes in aspect ratio.

getRotationAngle/setRotationAngle

→ inherited from Shape
public double getRotationAngle() / public void setRotationAngle(double value)
Gets and sets the rotation of the shape.

setRotationAngle

→ inherited from Shape
public void setRotationAngle(double value)
Gets and sets the rotation of the shape.

getHyperlink

→ inherited from Shape
public Hyperlink getHyperlink()
Gets the hyperlink of the shape.

getId

→ inherited from Shape
public int getId()
Gets the identifier of this shape.

getSpid

→ inherited from Shape
public java.lang.String getSpid()
Specifies an optional string that an application can use to Identify the particular shape.

getSpt

→ inherited from Shape
public int getSpt()
Specifies an optional number that an application can use to associate the particular shape with a defined shape type.

getWorksheet

→ inherited from Shape
public Worksheet getWorksheet()
Gets the Worksheet object which contains this shape.

isGroup

→ inherited from Shape
public boolean isGroup()
Indicates whether the shape is a group.

isInGroup

→ inherited from Shape
public boolean isInGroup()
Indicates whether the shape is grouped.

isWordArt

→ inherited from Shape
public boolean isWordArt()
Indicates whether this shape is a word art. Only for the Legacy Shape of xls file.

getTextEffect

→ inherited from Shape
public TextEffectFormat getTextEffect()
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.

isLocked/setLocked

→ inherited from Shape
public boolean isLocked() / public void setLocked(boolean value)
True if the object is locked, False if the object can be modified when the sheet is protected.

setLocked

→ inherited from Shape
public void setLocked(boolean value)
True if the object is locked, False if the object can be modified when the sheet is protected.

isPrintable/setPrintable

→ inherited from Shape
public boolean isPrintable() / public void setPrintable(boolean value)
True if the object is printable

setPrintable

→ inherited from Shape
public void setPrintable(boolean value)
True if the object is printable

getMsoDrawingType

→ inherited from Shape
public int getMsoDrawingType()
Gets mso drawing type. The value of the property is MsoDrawingType integer constant.

getAutoShapeType/setAutoShapeType

→ inherited from Shape
public int getAutoShapeType() / public void setAutoShapeType(int value)
Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.

setAutoShapeType

→ inherited from Shape
public void setAutoShapeType(int value)
Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.

getAnchorType/setAnchorType

→ inherited from Shape
public int getAnchorType() / public void setAnchorType(int value)
Gets and set the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.

setAnchorType

→ inherited from Shape
public void setAnchorType(int value)
Gets and set the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.

getPlacement/setPlacement

→ inherited from Shape
public int getPlacement() / 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. The value of the property is PlacementType integer constant.

setPlacement

→ inherited from Shape
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. The value of the property is PlacementType integer constant.

getUpperLeftRow/setUpperLeftRow

→ inherited from Shape
public int getUpperLeftRow() / public void setUpperLeftRow(int value)
Represents upper left corner row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.

setUpperLeftRow

→ inherited from Shape
public void setUpperLeftRow(int value)
Represents upper left corner row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.

getUpperDeltaY/setUpperDeltaY

→ inherited from Shape
public int getUpperDeltaY() / public void setUpperDeltaY(int value)
Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.

setUpperDeltaY

→ inherited from Shape
public void setUpperDeltaY(int 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

→ inherited from Shape
public int getUpperLeftColumn() / public void setUpperLeftColumn(int value)
Represents upper left corner column index.

setUpperLeftColumn

→ inherited from Shape
public void setUpperLeftColumn(int value)
Represents upper left corner column index.

getUpperDeltaX/setUpperDeltaX

→ inherited from Shape
public int getUpperDeltaX() / public void setUpperDeltaX(int value)
Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.

setUpperDeltaX

→ inherited from Shape
public void setUpperDeltaX(int 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

→ inherited from Shape
public int getLowerRightRow() / public void setLowerRightRow(int value)
Represents lower right corner row index.

setLowerRightRow

→ inherited from Shape
public void setLowerRightRow(int value)
Represents lower right corner row index.

getLowerDeltaY/setLowerDeltaY

→ inherited from Shape
public int getLowerDeltaY() / public void setLowerDeltaY(int value)
Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.

setLowerDeltaY

→ inherited from Shape
public void setLowerDeltaY(int 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

→ inherited from Shape
public int getLowerRightColumn() / public void setLowerRightColumn(int value)
Represents lower right corner column index.

setLowerRightColumn

→ inherited from Shape
public void setLowerRightColumn(int value)
Represents lower right corner column index.

getLowerDeltaX/setLowerDeltaX

→ inherited from Shape
public int getLowerDeltaX() / public void setLowerDeltaX(int value)
Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.

setLowerDeltaX

→ inherited from Shape
public void setLowerDeltaX(int 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

→ inherited from Shape
public int getRight() / public void setRight(int value)
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.

setRight

→ inherited from Shape
public void setRight(int value)
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.

getBottom/setBottom

→ inherited from Shape
public int getBottom() / public void setBottom(int value)
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.

setBottom

→ inherited from Shape
public void setBottom(int value)
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.

getWidth/setWidth

→ inherited from Shape
public int getWidth() / public void setWidth(int value)
Represents the width of shape, in unit of pixels.

setWidth

→ inherited from Shape
public void setWidth(int value)
Represents the width of shape, in unit of pixels.

getWidthInch/setWidthInch

→ inherited from Shape
public double getWidthInch() / public void setWidthInch(double value)
Represents the width of the shape, in unit of inch.

setWidthInch

→ inherited from Shape
public void setWidthInch(double value)
Represents the width of the shape, in unit of inch.

getWidthPt/setWidthPt

→ inherited from Shape
public double getWidthPt() / public void setWidthPt(double value)
Represents the width of the shape, in unit of point.

setWidthPt

→ inherited from Shape
public void setWidthPt(double value)
Represents the width of the shape, in unit of point.

getWidthCM/setWidthCM

→ inherited from Shape
public double getWidthCM() / public void setWidthCM(double value)
Represents the width of the shape, in unit of centimeters.

setWidthCM

→ inherited from Shape
public void setWidthCM(double value)
Represents the width of the shape, in unit of centimeters.

getHeight/setHeight

→ inherited from Shape
public int getHeight() / public void setHeight(int value)
Represents the height of shape, in unit of pixel.

setHeight

→ inherited from Shape
public void setHeight(int value)
Represents the height of shape, in unit of pixel.

getHeightInch/setHeightInch

→ inherited from Shape
public double getHeightInch() / public void setHeightInch(double value)
Represents the height of the shape, in unit of inches.

setHeightInch

→ inherited from Shape
public void setHeightInch(double value)
Represents the height of the shape, in unit of inches.

getHeightPt/setHeightPt

→ inherited from Shape
public double getHeightPt() / public void setHeightPt(double value)
Represents the height of the shape, in unit of points.

setHeightPt

→ inherited from Shape
public void setHeightPt(double value)
Represents the height of the shape, in unit of points.

getHeightCM/setHeightCM

→ inherited from Shape
public double getHeightCM() / public void setHeightCM(double value)
Represents the height of the shape, in unit of centimeters.

setHeightCM

→ inherited from Shape
public void setHeightCM(double value)
Represents the height of the shape, in unit of centimeters.

getLeft/setLeft

→ inherited from Shape
public int getLeft() / public void setLeft(int value)
Represents the horizontal offset of shape from its left column, in unit of pixels.

setLeft

→ inherited from Shape
public void setLeft(int value)
Represents the horizontal offset of shape from its left column, in unit of pixels.

getLeftInch/setLeftInch

→ inherited from Shape
public double getLeftInch() / public void setLeftInch(double value)
Represents the horizontal offset of shape from its left column, in unit of inches.

setLeftInch

→ inherited from Shape
public void setLeftInch(double value)
Represents the horizontal offset of shape from its left column, in unit of inches.

getLeftCM/setLeftCM

→ inherited from Shape
public double getLeftCM() / public void setLeftCM(double value)
Represents the horizontal offset of shape from its left column, in unit of centimeters.

setLeftCM

→ inherited from Shape
public void setLeftCM(double value)
Represents the horizontal offset of shape from its left column, in unit of centimeters.

getTop/setTop

→ inherited from Shape
public int getTop() / public void setTop(int 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.

setTop

→ inherited from Shape
public void setTop(int 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

→ inherited from Shape
public double getTopInch() / public void setTopInch(double value)
Represents the vertical offset of shape from its top row, in unit of inches.

setTopInch

→ inherited from Shape
public void setTopInch(double value)
Represents the vertical offset of shape from its top row, in unit of inches.

getTopCM/setTopCM

→ inherited from Shape
public double getTopCM() / public void setTopCM(double value)
Represents the vertical offset of shape from its top row, in unit of centimeters.

setTopCM

→ inherited from Shape
public void setTopCM(double value)
Represents the vertical offset of shape from its top row, in unit of centimeters.

getTopToCorner/setTopToCorner

→ inherited from Shape
public int getTopToCorner() / public void setTopToCorner(int value)
Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

setTopToCorner

→ inherited from Shape
public void setTopToCorner(int value)
Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

getLeftToCorner/setLeftToCorner

→ inherited from Shape
public int getLeftToCorner() / public void setLeftToCorner(int value)
Gets and sets the horizonal offset of shape from worksheet left border.

setLeftToCorner

→ inherited from Shape
public void setLeftToCorner(int value)
Gets and sets the horizonal offset of shape from worksheet left border.

getX/setX

→ inherited from Shape
public int getX() / public void setX(int value)
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

setX

→ inherited from Shape
public void setX(int value)
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

getY/setY

→ inherited from Shape
public int getY() / public void setY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

setY

→ inherited from Shape
public void setY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

getWidthScale/setWidthScale

→ inherited from Shape
public int getWidthScale() / public void setWidthScale(int 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;

setWidthScale

→ inherited from Shape
public void setWidthScale(int 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

→ inherited from Shape
public int getHeightScale() / public void setHeightScale(int 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;

setHeightScale

→ inherited from Shape
public void setHeightScale(int 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

→ inherited from Shape
public int getTopInShape() / 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. Only Applies when this shape in the group or chart.

setTopInShape

→ inherited from Shape
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. Only Applies when this shape in the group or chart.

getLeftInShape/setLeftInShape

→ inherited from Shape
public int getLeftInShape() / 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. Only Applies when this shape in the group or chart.

setLeftInShape

→ inherited from Shape
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. Only Applies when this shape in the group or chart.

getWidthInShape/setWidthInShape

→ inherited from Shape
public int getWidthInShape() / public void setWidthInShape(int 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.

setWidthInShape

→ inherited from Shape
public void setWidthInShape(int 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

→ inherited from Shape
public int getHeightInShape() / 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.. Only Applies when this shape in the group or chart.

setHeightInShape

→ inherited from Shape
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.. Only Applies when this shape in the group or chart.

getHeightInChart/setHeightInChart

→ inherited from Shape
public int getHeightInChart() / public void setHeightInChart(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.. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.HeightInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

setHeightInChart

→ inherited from Shape
public void setHeightInChart(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.. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.HeightInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getLeftInChart/setLeftInChart

→ inherited from Shape
public int getLeftInChart() / public void setLeftInChart(int value)
Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.LeftInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

setLeftInChart

→ inherited from Shape
public void setLeftInChart(int value)
Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.LeftInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getTopInChart/setTopInChart

→ inherited from Shape
public int getTopInChart() / public void setTopInChart(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. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.TopInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

setTopInChart

→ inherited from Shape
public void setTopInChart(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. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.TopInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getWidthInChart/setWidthInChart

→ inherited from Shape
public int getWidthInChart() / public void setWidthInChart(int value)
Represents the width of the shape, in unit of 1/4000 of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.WidthInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

setWidthInChart

→ inherited from Shape
public void setWidthInChart(int value)
Represents the width of the shape, in unit of 1/4000 of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.WidthInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getPositionX/setPositionX

→ inherited from Shape
public int getPositionX() / public void setPositionX(int value)
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.X property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

setPositionX

→ inherited from Shape
public void setPositionX(int value)
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.X property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getPositionY/setPositionY

→ inherited from Shape
public int getPositionY() / public void setPositionY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.Y property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

setPositionY

→ inherited from Shape
public void setPositionY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.Y property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getGroup

→ inherited from Shape
public GroupShape getGroup()
Gets the group shape which contains this shape.

getType

→ inherited from Shape
public int getType()
Gets the auto shape type. The value of the property is AutoShapeType integer constant.

hasLine/setHasLine

→ inherited from Shape
public boolean hasLine() / public void setHasLine(boolean value)
Gets and sets the line border of the shape is visible.

setHasLine

→ inherited from Shape
public void setHasLine(boolean value)
Gets and sets the line border of the shape is visible.

isFilled/setFilled

→ inherited from Shape
public boolean isFilled() / public void setFilled(boolean value)
Indicates whether the fill format is visible.

setFilled

→ inherited from Shape
public void setFilled(boolean value)
Indicates whether the fill format is visible.

isFlippedHorizontally/setFlippedHorizontally

→ inherited from Shape
public boolean isFlippedHorizontally() / public void setFlippedHorizontally(boolean value)
Gets and sets whether shape is horizontally flipped .

setFlippedHorizontally

→ inherited from Shape
public void setFlippedHorizontally(boolean value)
Gets and sets whether shape is horizontally flipped .

isFlippedVertically/setFlippedVertically

→ inherited from Shape
public boolean isFlippedVertically() / public void setFlippedVertically(boolean value)
Gets and sets whether shape is vertically flipped .

setFlippedVertically

→ inherited from Shape
public void setFlippedVertically(boolean value)
Gets and sets whether shape is vertically flipped .

getActualLowerRightRow

→ inherited from Shape
public int getActualLowerRightRow()
Get the actual bottom row.

getConnectionPoints

→ inherited from Shape
public java.awt.geom.Point2D.Float[] getConnectionPoints()
Get the connection points NOTE: This member is now obsolete. Instead, please use GetConnectionPoints() method. This method will be removed 12 months later since April 2022. Aspose apologizes for any inconvenience you may have experienced.

getRelativeToOriginalPictureSize/setRelativeToOriginalPictureSize

→ inherited from Shape
public boolean getRelativeToOriginalPictureSize() / public void setRelativeToOriginalPictureSize(boolean value)
Indicates whether shape is relative to original picture size.

setRelativeToOriginalPictureSize

→ inherited from Shape
public void setRelativeToOriginalPictureSize(boolean value)
Indicates whether shape is relative to original picture size.

getLinkedCell/setLinkedCell

→ inherited from Shape
public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)
Gets or sets the worksheet range linked to the control's value.

setLinkedCell

→ inherited from Shape
public void setLinkedCell(java.lang.String value)
Gets or sets the worksheet range linked to the control's value.

getInputRange/setInputRange

→ inherited from Shape
public java.lang.String getInputRange() / public void setInputRange(java.lang.String value)
Gets or sets the worksheet range used to fill the specified combo box.

setInputRange

→ inherited from Shape
public void setInputRange(java.lang.String value)
Gets or sets the worksheet range used to fill the specified combo box.

getTextShapeType/setTextShapeType

→ inherited from Shape
public int getTextShapeType() / public void setTextShapeType(int value)
Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.

setTextShapeType

→ inherited from Shape
public void setTextShapeType(int value)
Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.

getTextBody

→ inherited from Shape
public FontSettingCollection getTextBody()
Gets and sets the setting of the shape's text.

getFont/setFont

→ inherited from Shape
public Font getFont() / public void setFont(Font value)
Represents the font of shape.

setFont

→ inherited from Shape
public void setFont(Font value)
Represents the font of shape.

getTextOptions/setTextOptions

→ inherited from Shape
public TextOptions getTextOptions() / public void setTextOptions(TextOptions value)
Represents the text options of the shape.

setTextOptions

→ inherited from Shape
public void setTextOptions(TextOptions value)
Represents the text options of the shape.

getText/setText

→ inherited from Shape
public java.lang.String getText() / public void setText(java.lang.String value)
Represents the string in this TextBox object.

setText

→ inherited from Shape
public void setText(java.lang.String value)
Represents the string in this TextBox object.

isRichText

→ inherited from Shape
public boolean isRichText()
Whether or not the text is rich text.

getHtmlText/setHtmlText

→ inherited from Shape
public java.lang.String getHtmlText() / public void setHtmlText(java.lang.String value)
Gets and sets the html string which contains data and some formats in this textbox.

setHtmlText

→ inherited from Shape
public void setHtmlText(java.lang.String value)
Gets and sets the html string which contains data and some formats in this textbox.

getTextVerticalOverflow/setTextVerticalOverflow

→ inherited from Shape
public int getTextVerticalOverflow() / public void setTextVerticalOverflow(int value)
Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

setTextVerticalOverflow

→ inherited from Shape
public void setTextVerticalOverflow(int 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

→ inherited from Shape
public int getTextHorizontalOverflow() / public void setTextHorizontalOverflow(int value)
Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

setTextHorizontalOverflow

→ inherited from Shape
public void setTextHorizontalOverflow(int 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

→ inherited from Shape
public boolean isTextWrapped() / public void setTextWrapped(boolean value)
Gets and sets the text wrapped type of the shape which contains text.

setTextWrapped

→ inherited from Shape
public void setTextWrapped(boolean value)
Gets and sets the text wrapped type of the shape which contains text.

getTextOrientationType/setTextOrientationType

→ inherited from Shape
public int getTextOrientationType() / public void setTextOrientationType(int value)
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

setTextOrientationType

→ inherited from Shape
public void setTextOrientationType(int value)
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

getTextHorizontalAlignment/setTextHorizontalAlignment

→ inherited from Shape
public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

setTextHorizontalAlignment

→ inherited from Shape
public void setTextHorizontalAlignment(int value)
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

getTextVerticalAlignment/setTextVerticalAlignment

→ inherited from Shape
public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

setTextVerticalAlignment

→ inherited from Shape
public void setTextVerticalAlignment(int value)
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

getTextDirection/setTextDirection

→ inherited from Shape
public int getTextDirection() / public void setTextDirection(int value)
Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.

setTextDirection

→ inherited from Shape
public void setTextDirection(int value)
Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.

getControlData

→ inherited from Shape
public byte[] getControlData()
Gets the data of control.

getActiveXControl

→ inherited from Shape
public ActiveXControl getActiveXControl()
Gets the ActiveX control.

getPaths

→ inherited from Shape
public ShapePathCollection getPaths()
Gets the paths of a custom geometric shape.

getGeometry

→ inherited from Shape
public Geometry getGeometry()
Gets the geometry

Method Detail

selectedItem

public void selectedItem(int itemIndex, boolean isSelected)
Sets whether the item is selected
Parameters:
itemIndex - The item index
isSelected - Whether the item is selected. True means that this item should be selected. False means that this item should be unselected.

isSelected

public boolean isSelected(int itemIndex)
Indicates whether the item is selected.
Parameters:
itemIndex - The item index.
Returns:
whether the item is selected.

getLinkedCell

→ inherited from Shape
public java.lang.String getLinkedCell(boolean isR1C1, boolean isLocal)
Gets the range linked to the control's value.
Parameters:
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.
Returns:
The range linked to the control's value.

setLinkedCell

→ inherited from Shape
public void setLinkedCell(java.lang.String formula, boolean isR1C1, boolean isLocal)
Sets the range linked to the control's value.
Parameters:
formula - The range linked to the control's value.
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.

getInputRange

→ inherited from Shape
public java.lang.String getInputRange(boolean isR1C1, boolean isLocal)
Gets the range used to fill the control.
Parameters:
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.
Returns:
The range used to fill the control.

setInputRange

→ inherited from Shape
public void setInputRange(java.lang.String formula, boolean isR1C1, boolean isLocal)
Sets the range used to fill the control.
Parameters:
formula - The range used to fill the control.
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.

updateSelectedValue

→ inherited from Shape
public void updateSelectedValue()
                        throws java.lang.Exception
Update the selected value by the value of the linked cell.

calculateTextSize

→ inherited from Shape
public int[] calculateTextSize()
                       throws java.lang.Exception
Recalculate the text area
Returns:
Text's Size in an array(width and height).

formatCharacters

→ inherited from Shape
public void formatCharacters(int startIndex, int length, Font font, StyleFlag flag)
                     throws java.lang.Exception
Formats some characters with the font setting.
Parameters:
startIndex - The start index.
length - The length.
font - The font setting.
flag - The flag of the font setting.

formatCharacters

→ inherited from Shape
public void formatCharacters(int startIndex, int length, Font font)
Formats some characters with the font setting. NOTE: This member is now obsolete. Instead, please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method. This property will be removed 12 months later since March 2016. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
startIndex - The start index.
length - The length.
font - The font setting.

characters

→ inherited from Shape
public FontSetting characters(int startIndex, int length)
Returns a Characters object that represents a range of characters within the text. This method only works on shape with title.
Parameters:
startIndex - The index of the start of the character.
length - The number of characters.
Returns:
Characters object.

getCharacters

→ inherited from Shape
public java.util.ArrayList getCharacters()
                       throws java.lang.Exception
Returns all Characters objects that represents a range of characters within the text .
Returns:
All Characters objects

removeActiveXControl

→ inherited from Shape
public void removeActiveXControl()
Remove activeX control.

isSameSetting

→ inherited from Shape
public boolean isSameSetting(java.lang.Object obj)
Returns whether the shape is same.
Parameters:
obj -
Returns:

getConnectionPoints

→ inherited from Shape
public float[][] getConnectionPoints()
Get the connection points
Returns:
[X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.

toImage

→ inherited from Shape
public void toImage(java.io.OutputStream stream, ImageFormat imageFormat)
            throws java.lang.Exception
Creates the shape image and saves it to a stream in the specified format.

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

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

toImage

→ inherited from Shape
public void toImage(java.lang.String imageFile, ImageOrPrintOptions options)
            throws java.lang.Exception
Saves the shape to a file.

toImage

→ inherited from Shape
public void toImage(java.io.OutputStream stream, ImageOrPrintOptions options)
            throws java.lang.Exception
Saves the shape to a stream.

getResultOfSmartArt

→ inherited from Shape
public GroupShape getResultOfSmartArt()
                              throws java.lang.Exception
Converting smart art to grouped shapes.

toFrontOrBack

→ inherited from Shape
public void toFrontOrBack(int orders)
Brings the shape to the front or sends the shape to back.
Parameters:
orders - If it's less than zero, sets the shape to back. If it's greater than zero, brings the shape to front.

getLockedProperty

→ inherited from Shape
public boolean getLockedProperty(int type)
Gets the value of locked property.
Parameters:
type - A ShapeLockType value. The type of the shape locked property.
Returns:
Returns the value of locked property.

setLockedProperty

→ inherited from Shape
public void setLockedProperty(int type, boolean value)
Set the locked property.
Parameters:
type - A ShapeLockType value. The locked type.
value - The value of the property.

addHyperlink

→ inherited from Shape
public Hyperlink addHyperlink(java.lang.String address)
Adds a hyperlink to the shape.
Parameters:
address - Address of the hyperlink.
Returns:
Return the new hyperlink object.

removeHyperlink

→ inherited from Shape
public void removeHyperlink()
Remove the hyperlink of the shape.

moveToRange

→ inherited from Shape
public void moveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)
Moves the shape to a specified range.
Parameters:
upperLeftRow - Upper left row index.
upperLeftColumn - Upper left column index.
lowerRightRow - Lower right row index
lowerRightColumn - Lower right column index

alignTopRightCorner

→ inherited from Shape
public void alignTopRightCorner(int topRow, int rightColumn)
Moves the picture to the top-right corner.
Parameters:
topRow - the row index.
rightColumn - the column index.

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





© 2015 - 2024 Weber Informatics LLC | Privacy Policy