IShape

All Superinterfaces:

IContainer

All Known Subinterfaces:

IBackgroundPicture
```
public interface IShape
extends IContainer
```
Represents an object in the drawing layer, such as an AutoShape, chart, or picture. The Shape object is a member of the IShapes collection. The Shapes collection contains all the shapes on a slide.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`delete()` Deletes the object.
`IShape`	`duplicate()` Duplicates the shape and returns a reference to the new copy.
`void`	`fromJson(java.lang.String json)` Generate a new shape from the json string.
`IAdjustments`	`getAdjustments()` Gets a collection of adjustment values for the specified AutoShape or connector.
`AutoShapeType`	`getAutoShapeType()` Returns the shape type for the specified `IShape` object, which must represent an AutoShape other than a line, freeform drawing, or connector.
`IRange`	`getBottomRightCell()` Returns the `IRange` object that represents the cell that lies under the lower-right corner of the object.
`IChart`	`getChart()` Returns an object that represents the `IChart` contained in this shape.
`boolean`	`getConnector()` Gets whether the specified shape is a connector.
`IConnectorFormat`	`getConnectorFormat()` Returns the `IConnectorFormat` object that contains connector formatting properties.
`IControl`	`getControl()` Gets the associated control.
`IFillFormat`	`getFill()` Returns the `IFillFormat` object that contains fill formatting properties for the specified chart or shape.
`IGroupShapes`	`getGroupItems()` Returns the `IGroupShapes` object that represents the individual shapes in the specified group.
`boolean`	`getHasChart()` Returns information if the `IShape` contains a chart.
`IHyperlink`	`getHyperlink()` Returns a Hyperlink object that represents the hyperlink for the shape.
`boolean`	`getIsPrintable()` Gets whether the object should be printed
`ILineFormat`	`getLine()` Returns the `ILineFormat` object that contains line formatting properties for the specified shape.
`boolean`	`getLocked()` Gets whether the object is locked (True if the object is locked, False if the object can be modified when the sheet is protected, read or write Boolean).
`java.lang.String`	`getName()` Returns the name of the object.
`IWorksheet`	`getParent()` Gets the shape's parent sheet
`IShape`	`getParentGroup()` Returns the `IShape` object that represents the common parent shape of a child shape or a range of child shapes.
`IPictureFormat`	`getPictureFormat()` Returns the `IPictureFormat` object that contains picture formatting properties for the specified shape.
`Placement`	`getPlacement()` Returns the way the object is attached to the cells below it.
`double`	`getRotation()` Returns the rotation of the shape in degrees.
`ITextFrame`	`getTextFrame()` Returns the `ITextFrame` object that contains the text and font style properties for the specified shape.
`IThreeDFormat`	`getThreeD()` Returns the `IThreeDFormat` object that contains 3-D – effect formatting properties for the specified shape.
`java.lang.String`	`getTitle()` Gets the title of the alternative text associated with the specified shape.
`IRange`	`getTopLeftCell()` Returns the `IRange` object that represents the cell that lies under the upper-left corner of the specified object.
`ShapeType`	`getType()` Returns the shape type
`boolean`	`getVisible()` Determines whether the object is visible
`int`	`getZOrderPosition()` Gets the position of the specified shape in the z-order.
`void`	`setAutoShapeType(AutoShapeType value)` Sets the shape type for the specified `IShape` object, which must represent an AutoShape other than a line, freeform drawing, or connector.
`void`	`setIsPrintable(boolean value)` Sets whether the object should be printed
`void`	`setLocked(boolean value)` Sets whether the object is locked (True if the object is locked, False if the object can be modified when the sheet is protected, read or write Boolean).
`void`	`setName(java.lang.String value)` Sets the name of the object.
`void`	`setPlacement(Placement value)` Sets the way the object is attached to the cells below it.
`void`	`setRotation(double value)` Sets the rotation of the shape in degrees.
`void`	`setTitle(java.lang.String value)` Sets the title of the alternative text associated with the specified shape.
`void`	`setVisible(boolean value)` Determines whether the object is visible
`void`	`toImage(java.io.OutputStream stream, ImageType imageType)` Saves the shape to the specified image stream.
`void`	`toImage(java.lang.String fileName)` Saves the shape to a image file.
`java.lang.String`	`toJson()` Generates a json string from the shape.
`IShapeRange`	`ungroup()` Ungroups any grouped shapes in the specified shape or range of shapes.
`void`	`zOrder(ZOrderType zOrderType)` Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order).

Methods inherited from interface com.grapecity.documents.excel.drawing.IContainer
getHeight, getHeightInPixel, getLeft, getLeftInPixel, getTop, getTopInPixel, getWidth, getWidthInPixel, setHeight, setHeightInPixel, setLeft, setLeftInPixel, setTop, setTopInPixel, setWidth, setWidthInPixel

- Method Detail
  - getControl
```
IControl getControl()
```
    Gets the associated control. value: The associated control. null if the shape is not a control.
  - ungroup
```
IShapeRange ungroup()
```
    Ungroups any grouped shapes in the specified shape or range of shapes. Disassembles pictures and OLE objects within the specified shape or range of shapes.
    
    Returns:
    
    A ShapeRange object that represents the ungrouped shapes.
  - getParent
```
IWorksheet getParent()
```
    Gets the shape's parent sheet
  - getName
```
java.lang.String getName()
```
    Returns the name of the object.
  - setName
```
void setName(java.lang.String value)
```
    Sets the name of the object.
  - getTopLeftCell
```
IRange getTopLeftCell()
```
    Returns the IRange object that represents the cell that lies under the upper-left corner of the specified object.
  - getBottomRightCell
```
IRange getBottomRightCell()
```
    Returns the IRange object that represents the cell that lies under the lower-right corner of the object.
  - getTitle
```
java.lang.String getTitle()
```
    Gets the title of the alternative text associated with the specified shape.
  - setTitle
```
void setTitle(java.lang.String value)
```
    Sets the title of the alternative text associated with the specified shape.
  - getRotation
```
double getRotation()
```
    Returns the rotation of the shape in degrees.
  - setRotation
```
void setRotation(double value)
```
    Sets the rotation of the shape in degrees.
  - getChart
```
IChart getChart()
```
    Returns an object that represents the IChart contained in this shape.
  - getAutoShapeType
```
AutoShapeType getAutoShapeType()
```
    Returns the shape type for the specified IShape object, which must represent an AutoShape other than a line, freeform drawing, or connector.
  - setAutoShapeType
```
void setAutoShapeType(AutoShapeType value)
```
    Sets the shape type for the specified IShape object, which must represent an AutoShape other than a line, freeform drawing, or connector.
  - getConnector
```
boolean getConnector()
```
    Gets whether the specified shape is a connector.
  - getConnectorFormat
```
IConnectorFormat getConnectorFormat()
```
    Returns the IConnectorFormat object that contains connector formatting properties. Applies to IShape objects that represent connectors.
  - getFill
```
IFillFormat getFill()
```
    Returns the IFillFormat object that contains fill formatting properties for the specified chart or shape.
  - getHasChart
```
boolean getHasChart()
```
    Returns information if the IShape contains a chart.
  - getLine
```
ILineFormat getLine()
```
    Returns the ILineFormat object that contains line formatting properties for the specified shape.
  - getParentGroup
```
IShape getParentGroup()
```
    Returns the IShape object that represents the common parent shape of a child shape or a range of child shapes.
  - getGroupItems
```
IGroupShapes getGroupItems()
```
    Returns the IGroupShapes object that represents the individual shapes in the specified group. Use the indexer of IGroupShapes to return a single shape from the group.
  - getPictureFormat
```
IPictureFormat getPictureFormat()
```
    Returns the IPictureFormat object that contains picture formatting properties for the specified shape.
  - getTextFrame
```
ITextFrame getTextFrame()
```
    Returns the ITextFrame object that contains the text and font style properties for the specified shape.
  - getPlacement
```
Placement getPlacement()
```
    Returns the way the object is attached to the cells below it.
  - setPlacement
```
void setPlacement(Placement value)
```
    Sets the way the object is attached to the cells below it.
  - getThreeD
```
IThreeDFormat getThreeD()
```
    Returns the IThreeDFormat object that contains 3-D – effect formatting properties for the specified shape.
  - getType
```
ShapeType getType()
```
    Returns the shape type
  - getVisible
```
boolean getVisible()
```
    Determines whether the object is visible
  - setVisible
```
void setVisible(boolean value)
```
    Determines whether the object is visible
  - getIsPrintable
```
boolean getIsPrintable()
```
    Gets whether the object should be printed
  - setIsPrintable
```
void setIsPrintable(boolean value)
```
    Sets whether the object should be printed
  - getLocked
```
boolean getLocked()
```
    Gets whether the object is locked (True if the object is locked, False if the object can be modified when the sheet is protected, read or write Boolean).
  - setLocked
```
void setLocked(boolean value)
```
    Sets whether the object is locked (True if the object is locked, False if the object can be modified when the sheet is protected, read or write Boolean).
  - getZOrderPosition
```
int getZOrderPosition()
```
    Gets the position of the specified shape in the z-order.
  - delete
```
void delete()
```
    Deletes the object.
  - duplicate
```
IShape duplicate()
```
    Duplicates the shape and returns a reference to the new copy.
  - zOrder
```
void zOrder(ZOrderType zOrderType)
```
    Moves the specified shape in front of or behind other shapes in the collection (that is, changes the shape's position in the z-order).
    
    Parameters:
    
    zOrderType - Required com.grapecity.documents.excel.drawing.ZOrderType. Specifies where to move the specified shape relative to the other shapes.
  - getAdjustments
```
IAdjustments getAdjustments()
```
    Gets a collection of adjustment values for the specified AutoShape or connector.
  - getHyperlink
```
IHyperlink getHyperlink()
```
    Returns a Hyperlink object that represents the hyperlink for the shape.
  - toImage
```
void toImage(java.lang.String fileName)
```
    Saves the shape to a image file.
  - toImage
```
void toImage(java.io.OutputStream stream,
             ImageType imageType)
```
    Saves the shape to the specified image stream.
    
    Parameters:
    
    stream - The output image stream.
    
    imageType - Specifies the type of image to create.
  - fromJson
```
void fromJson(java.lang.String json)
```
    Generate a new shape from the json string.
    
    Parameters:
    
    json - the json string represents a shape
  - toJson
```
java.lang.String toJson()
```
    Generates a json string from the shape.
    
    Returns:
    
    the json string

Interface IShape

Method Summary

Methods inherited from interface com.grapecity.documents.excel.drawing.IContainer

Method Detail

getControl

ungroup

getParent

getName

setName

getTopLeftCell

getBottomRightCell

getTitle

setTitle

getRotation

setRotation

getChart

getAutoShapeType

setAutoShapeType

getConnector

getConnectorFormat

getFill

getHasChart

getLine

getParentGroup

getGroupItems

getPictureFormat

getTextFrame

getPlacement

setPlacement

getThreeD

getType

getVisible

setVisible

getIsPrintable

setIsPrintable

getLocked

setLocked

getZOrderPosition

delete

duplicate

zOrder

getAdjustments

getHyperlink

toImage

toImage

fromJson

toJson