IShape (Aspose.Slides for Java (25.10) API Documentation)

All Superinterfaces:

IHyperlinkContainer, IPresentationComponent, ISlideComponent

All Known Subinterfaces:

IAudioFrame, IAutoShape, IChart, IConnector, IGeometryShape, IGraphicalObject, IGroupShape, IInk, IInkActions, ILegacyDiagram, IOleObjectFrame, IPictureFrame, ISectionZoomFrame, ISmartArt, ISmartArtShape, ISummaryZoomFrame, ISummaryZoomSection, ITable, IVideoFrame, IZoomFrame, IZoomObject

All Known Implementing Classes:

AudioFrame, AutoShape, Chart, Connector, GeometryShape, GraphicalObject, GroupShape, Ink, InkActions, LegacyDiagram, OleObjectFrame, PictureFrame, SectionZoomFrame, Shape, SmartArt, SmartArtShape, SummaryZoomFrame, SummaryZoomSection, Table, VideoFrame, ZoomFrame, ZoomObject
```
public interface IShape
extends ISlideComponent, IHyperlinkContainer
```
Represents a shape on a slide.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`IPlaceholder`	`addPlaceholder(IPlaceholder placeholderToCopyFrom)` Adds a new placeholder if there is no and sets placeholder properties to a specified one.
`java.lang.String`	`getAlternativeText()` Returns or sets the alternative text associated with a shape.
`java.lang.String`	`getAlternativeTextTitle()` Returns or sets the title of alternative text associated with a shape.
`IShape`	`getBasePlaceholder()` Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from).
`byte`	`getBlackWhiteMode()` Property specifies how a shape will render in black-and-white display mode..
`int`	`getConnectionSiteCount()` Returns the number of connection sites on the shape.
`ICustomData`	`getCustomData()` Returns the shape's custom data.
`IEffectFormat`	`getEffectFormat()` Returns the EffectFormat object which contains pixel effects applied to a shape.
`IFillFormat`	`getFillFormat()` Returns the FillFormat object that contains fill formatting properties for a shape.
`IShapeFrame`	`getFrame()` Returns or sets the shape frame's properties.
`float`	`getHeight()` Gets or sets the height of the shape, measured in points.
`boolean`	`getHidden()` Determines whether the shape is hidden.
`IImage`	`getImage()` Returns shape thumbnail.
`IImage`	`getImage(int bounds, float scaleX, float scaleY)` Returns shape thumbnail.
`ILineFormat`	`getLineFormat()` Returns the LineFormat object that contains line formatting properties for a shape.
`java.lang.String`	`getName()` Returns or sets the name of a shape.
`long`	`getOfficeInteropShapeId()` Returns a slide-scoped unique identifier that remains constant for the lifetime of the shape and lets PowerPoint or interop code reliably reference the shape from anywhere in the document.
`IGroupShape`	`getParentGroup()` Returns parent GroupShape object if shape is grouped.
`IPlaceholder`	`getPlaceholder()` Returns the placeholder for a shape.
`IShapeFrame`	`getRawFrame()` Returns or sets the raw shape frame's properties.
`float`	`getRotation()` Returns or sets the number of degrees the specified shape is rotated around the z-axis.
`IBaseShapeLock`	`getShapeLock()` Returns shape's locks.
`IThreeDFormat`	`getThreeDFormat()` Returns the ThreeDFormat object that contains line formatting properties for a shape.
`java.awt.image.BufferedImage`	`getThumbnail()` Deprecated. Use getImage method instead. The method will be removed after release of version 24.7.
`java.awt.image.BufferedImage`	`getThumbnail(int bounds, float scaleX, float scaleY)` Deprecated. Use getImage(ShapeThumbnailBounds bounds, float scaleX, float scaleY) method instead. The method will be removed after release of version 24.7.
`long`	`getUniqueId()` Returns an internal, presentation-scoped identifier intended for use by add-ins or other code.
`float`	`getWidth()` Gets or sets the width of the shape, measured in points.
`float`	`getX()` Gets or sets the x-coordinate of the shape's upper-left corner, measured in points.
`float`	`getY()` Gets or sets the y-coordinate of the shape's upper-left corner, measured in points.
`int`	`getZOrderPosition()` Returns the position of a shape in the z-order.
`boolean`	`isDecorative()` Gets or sets 'Mark as decorative' option Reed/write boolean.
`boolean`	`isGrouped()` Determines whether the shape is grouped.
`boolean`	`isTextHolder()` Determines whether the shape is TextHolder.
`void`	`removePlaceholder()` Defines that this shape isn't a placeholder.
`void`	`setAlternativeText(java.lang.String value)` Returns or sets the alternative text associated with a shape.
`void`	`setAlternativeTextTitle(java.lang.String value)` Returns or sets the title of alternative text associated with a shape.
`void`	`setBlackWhiteMode(byte value)` Property specifies how a shape will render in black-and-white display mode..
`void`	`setDecorative(boolean value)` Gets or sets 'Mark as decorative' option Reed/write boolean.
`void`	`setFrame(IShapeFrame value)` Returns or sets the shape frame's properties.
`void`	`setHeight(float value)` Gets or sets the height of the shape, measured in points.
`void`	`setHidden(boolean value)` Determines whether the shape is hidden.
`void`	`setName(java.lang.String value)` Returns or sets the name of a shape.
`void`	`setRawFrame(IShapeFrame value)` Returns or sets the raw shape frame's properties.
`void`	`setRotation(float value)` Returns or sets the number of degrees the specified shape is rotated around the z-axis.
`void`	`setWidth(float value)` Gets or sets the width of the shape, measured in points.
`void`	`setX(float value)` Gets or sets the x-coordinate of the shape's upper-left corner, measured in points.
`void`	`setY(float value)` Gets or sets the y-coordinate of the shape's upper-left corner, measured in points.
`void`	`writeAsSvg(java.io.OutputStream stream)` Saves content of Shape as SVG file.
`void`	`writeAsSvg(java.io.OutputStream stream, ISVGOptions svgOptions)` Saves content of Shape as SVG file.

Methods inherited from interface com.aspose.slides.ISlideComponent
getSlide

Methods inherited from interface com.aspose.slides.IPresentationComponent
getPresentation

Methods inherited from interface com.aspose.slides.IHyperlinkContainer
getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, setHyperlinkClick, setHyperlinkMouseOver

Method Detail

isTextHolder
```
boolean isTextHolder()
```
Determines whether the shape is TextHolder. Read-only boolean.

getPlaceholder
```
IPlaceholder getPlaceholder()
```
Returns the placeholder for a shape. Read-only IPlaceholder.

addPlaceholder
```
IPlaceholder addPlaceholder(IPlaceholder placeholderToCopyFrom)
```
Adds a new placeholder if there is no and sets placeholder properties to a specified one.

Parameters:

placeholderToCopyFrom - Placeholder to copy content from.

Returns:

New IPlaceholder.

removePlaceholder
```
void removePlaceholder()
```
Defines that this shape isn't a placeholder.

getCustomData
```
ICustomData getCustomData()
```
Returns the shape's custom data. Read-only ICustomData.

getRawFrame

IShapeFrame getRawFrame()

Returns or sets the raw shape frame's properties. Read/write IShapeFrame.

 Code that attempts to assign undefined frame to IShape.getFrame() doesn't make sense in general case (particularly in case when parent GroupShape is multiple nested into other GroupShape-s). For example:
  IShape shape = ...;
 shape.setFrame(new ShapeFrame(Float.NaN, Float.NaN, Float.NaN, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, Float.NaN));
 //or
 slide.getShapes().addAutoShape(ShapeType.RoundCornerRectangle, Float.NaN, Float.NaN, Float.NaN, Float.NaN);
 //Such code can lead to unclear situations. So restrictions had been added for using undefined values for IShape.getFrame(). Values of x, y, width, height, flipH, flipV and rotationAngle must be defined (not Float.NaN or NullableBool.NotDefined). Example code above now throws ArgumentException exception.
 //This applies to these use cases:
 IShape shape = ...;
 shape.setFrame(...); // cannot be undefined
 IShapeCollection shapes = ...;
 // x, y, width, height parameters cannot be Float.NaN:
 {
     shapes.addAudioFrameCD(...);
     shapes.addAudioFrameEmbedded(...);
     shapes.addAudioFrameLinked(...);
     shapes.addAutoShape(...);
     shapes.addChart(...);
     shapes.addConnector(...);
     shapes.addOleObjectFrame(...);
     shapes.addPictureFrame(...);
     shapes.addSmartArt(...);
     shapes.addTable(...);
     shapes.addVideoFrame(...);
     shapes.insertAudioFrameEmbedded(...);
     shapes.insertAudioFrameLinked(...);
     shapes.insertAutoShape(...);
     shapes.insertChart(...);
     shapes.insertConnector(...);
     shapes.insertOleObjectFrame(...);
     shapes.insertPictureFrame(...);
     shapes.insertTable(...);
     shapes.insertVideoFrame(...);
 }
 But IShape.RawFrame frame properties can be undefined. This make sense when shape is linked to placeholder. Then undefined shape frame values is overridden from the parent placeholder shape. If there is no parent placeholder shape for that shape then that shape uses default values when it evaluates effective frame based on its IShape.RawFrame. Default values are 0 and NullableBool.False for x, y, width, height, flipH, flipV and rotationAngle. For example:
 IShape shape = ...; // shape is linked to placeholder
 shape.setRawFrame(new ShapeFrame(Float.NaN, Float.NaN, 100, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, 0)); // now shape inherits x, y, height, flipH, flipV values form placeholder and overrides width=100 and rotationAngle=0.

setRawFrame

void setRawFrame(IShapeFrame value)

Returns or sets the raw shape frame's properties. Read/write IShapeFrame.

 Code that attempts to assign undefined frame to IShape.getFrame() doesn't make sense in general case (particularly in case when parent GroupShape is multiple nested into other GroupShape-s). For example:
  IShape shape = ...;
 shape.setFrame(new ShapeFrame(Float.NaN, Float.NaN, Float.NaN, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, Float.NaN));
 //or
 slide.getShapes().addAutoShape(ShapeType.RoundCornerRectangle, Float.NaN, Float.NaN, Float.NaN, Float.NaN);
 //Such code can lead to unclear situations. So restrictions had been added for using undefined values for IShape.getFrame(). Values of x, y, width, height, flipH, flipV and rotationAngle must be defined (not Float.NaN or NullableBool.NotDefined). Example code above now throws ArgumentException exception.
 //This applies to these use cases:
 IShape shape = ...;
 shape.setFrame(...); // cannot be undefined
 IShapeCollection shapes = ...;
 // x, y, width, height parameters cannot be Float.NaN:
 {
     shapes.addAudioFrameCD(...);
     shapes.addAudioFrameEmbedded(...);
     shapes.addAudioFrameLinked(...);
     shapes.addAutoShape(...);
     shapes.addChart(...);
     shapes.addConnector(...);
     shapes.addOleObjectFrame(...);
     shapes.addPictureFrame(...);
     shapes.addSmartArt(...);
     shapes.addTable(...);
     shapes.addVideoFrame(...);
     shapes.insertAudioFrameEmbedded(...);
     shapes.insertAudioFrameLinked(...);
     shapes.insertAutoShape(...);
     shapes.insertChart(...);
     shapes.insertConnector(...);
     shapes.insertOleObjectFrame(...);
     shapes.insertPictureFrame(...);
     shapes.insertTable(...);
     shapes.insertVideoFrame(...);
 }
 But IShape.RawFrame frame properties can be undefined. This make sense when shape is linked to placeholder. Then undefined shape frame values is overridden from the parent placeholder shape. If there is no parent placeholder shape for that shape then that shape uses default values when it evaluates effective frame based on its IShape.RawFrame. Default values are 0 and NullableBool.False for x, y, width, height, flipH, flipV and rotationAngle. For example:
 IShape shape = ...; // shape is linked to placeholder
 shape.setRawFrame(new ShapeFrame(Float.NaN, Float.NaN, 100, Float.NaN, NullableBool.NotDefined, NullableBool.NotDefined, 0)); // now shape inherits x, y, height, flipH, flipV values form placeholder and overrides width=100 and rotationAngle=0.

getFrame
```
IShapeFrame getFrame()
```
Returns or sets the shape frame's properties. Read/write IShapeFrame.
Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

setFrame
```
void setFrame(IShapeFrame value)
```
Returns or sets the shape frame's properties. Read/write IShapeFrame.
Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties.

getLineFormat
```
ILineFormat getLineFormat()
```
Returns the LineFormat object that contains line formatting properties for a shape. Read-only ILineFormat.

getThreeDFormat
```
IThreeDFormat getThreeDFormat()
```
Returns the ThreeDFormat object that contains line formatting properties for a shape. Read-only IThreeDFormat.

getEffectFormat
```
IEffectFormat getEffectFormat()
```
Returns the EffectFormat object which contains pixel effects applied to a shape. Read-only IEffectFormat.

getFillFormat
```
IFillFormat getFillFormat()
```
Returns the FillFormat object that contains fill formatting properties for a shape. Read-only IFillFormat.

getThumbnail
```
@Deprecated
java.awt.image.BufferedImage getThumbnail()
```
Deprecated. Use getImage method instead. The method will be removed after release of version 24.7.

Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

Returns:

Shape thumbnail.

getImage
```
IImage getImage()
```
Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.

Returns:

Shape thumbnail.

getThumbnail
```
@Deprecated
java.awt.image.BufferedImage getThumbnail(int bounds,
                                                       float scaleX,
                                                       float scaleY)
```
Deprecated. Use getImage(ShapeThumbnailBounds bounds, float scaleX, float scaleY) method instead. The method will be removed after release of version 24.7.

Returns shape thumbnail.

Parameters:

bounds - Shape thumbnail bounds type.

scaleX - X scale

scaleY - Y scale

Returns:

Shape thumbnail or null in case when ShapeThumbnailBounds.Appearance is used and a shape doesn't have visible elements.

getImage
```
IImage getImage(int bounds,
                float scaleX,
                float scaleY)
```
Returns shape thumbnail.

Parameters:

bounds - Shape thumbnail bounds type.

scaleX - X scale

scaleY - Y scale

Returns:

Shape thumbnail or null in case when ShapeThumbnailBounds.Appearance is used and a shape doesn't have visible elements.

getHidden
```
boolean getHidden()
```
Determines whether the shape is hidden. Read/write boolean.

setHidden
```
void setHidden(boolean value)
```
Determines whether the shape is hidden. Read/write boolean.

getZOrderPosition
```
int getZOrderPosition()
```
Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int.

getConnectionSiteCount
```
int getConnectionSiteCount()
```
Returns the number of connection sites on the shape. Read-only int.

getRotation
```
float getRotation()
```
Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float.
Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

setRotation
```
void setRotation(float value)
```
Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float.
Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties.

getX
```
float getX()
```
Gets or sets the x-coordinate of the shape's upper-left corner, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

setX
```
void setX(float value)
```
Gets or sets the x-coordinate of the shape's upper-left corner, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

getY
```
float getY()
```
Gets or sets the y-coordinate of the shape's upper-left corner, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

setY
```
void setY(float value)
```
Gets or sets the y-coordinate of the shape's upper-left corner, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

getWidth
```
float getWidth()
```
Gets or sets the width of the shape, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

setWidth
```
void setWidth(float value)
```
Gets or sets the width of the shape, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

getHeight
```
float getHeight()
```
Gets or sets the height of the shape, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

setHeight
```
void setHeight(float value)
```
Gets or sets the height of the shape, measured in points. Read/write float.
The value returned is always defined and never Float.NaN. The value assigned must also be defined; assign Float.NaN only to properties of a RawFrame instance.

getAlternativeText
```
java.lang.String getAlternativeText()
```
Returns or sets the alternative text associated with a shape. Read/write String.

setAlternativeText
```
void setAlternativeText(java.lang.String value)
```
Returns or sets the alternative text associated with a shape. Read/write String.

getAlternativeTextTitle
```
java.lang.String getAlternativeTextTitle()
```
Returns or sets the title of alternative text associated with a shape. Read/write String.

setAlternativeTextTitle
```
void setAlternativeTextTitle(java.lang.String value)
```
Returns or sets the title of alternative text associated with a shape. Read/write String.

getName
```
java.lang.String getName()
```
Returns or sets the name of a shape. Read/write String.

setName
```
void setName(java.lang.String value)
```
Returns or sets the name of a shape. Read/write String.

isDecorative

boolean isDecorative()

Gets or sets 'Mark as decorative' option Reed/write boolean.

  Presentation pres = new Presentation("sample.pptx");
 try {
    pres.getSlides().get_Item(0).getShapes().get_Item(0).setDecorative(true);
 } finally {
     if (pres != null) pres.dispose();
 }

setDecorative

void setDecorative(boolean value)

Gets or sets 'Mark as decorative' option Reed/write boolean.

  Presentation pres = new Presentation("sample.pptx");
 try {
    pres.getSlides().get_Item(0).getShapes().get_Item(0).setDecorative(true);
 } finally {
     if (pres != null) pres.dispose();
 }

getShapeLock
```
IBaseShapeLock getShapeLock()
```
Returns shape's locks. Read-only IBaseShapeLock.

getUniqueId
```
long getUniqueId()
```
Returns an internal, presentation-scoped identifier intended for use by add-ins or other code. Because this value can be reassigned by the user or programmatically, it must not be treated as a persistent unique key. Read-only long. See also getOfficeInteropShapeId().

getOfficeInteropShapeId
```
long getOfficeInteropShapeId()
```
Returns a slide-scoped unique identifier that remains constant for the lifetime of the shape and lets PowerPoint or interop code reliably reference the shape from anywhere in the document. Read-only long. See also getUniqueId().

isGrouped
```
boolean isGrouped()
```
Determines whether the shape is grouped. Read-only boolean.
Property getParentGroup() returns parent GroupShape object if shape is grouped.

getBlackWhiteMode
```
byte getBlackWhiteMode()
```
Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

setBlackWhiteMode
```
void setBlackWhiteMode(byte value)
```
Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode.

getParentGroup
```
IGroupShape getParentGroup()
```
Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape.
Property isGrouped() determines whether the shape is grouped.

writeAsSvg
```
void writeAsSvg(java.io.OutputStream stream)
```
Saves content of Shape as SVG file.

Parameters:

stream - Target stream

writeAsSvg
```
void writeAsSvg(java.io.OutputStream stream,
                ISVGOptions svgOptions)
```
Saves content of Shape as SVG file.

Parameters:

stream - Target stream

svgOptions - SVG generation options

getBasePlaceholder

IShape getBasePlaceholder()

Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from).

  // get all (master/layout/slide) animated effects of the placeholder shape
 Presentation pres = new Presentation("sample.pptx");
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     IShape shape = slide.getShapes().get_Item(0);
     IEffect[] shapeEffects = slide.getTimeline().getMainSequence().getEffectsByShape(shape);
     IShape layoutShape = shape.getBasePlaceholder();
     IEffect[] layoutShapeEffects = slide.getLayoutSlide().getTimeline().getMainSequence().getEffectsByShape(layoutShape);
     IShape masterShape = layoutShape.getBasePlaceholder();
     IEffect[] masterShapeEffects = slide.getLayoutSlide().getMasterSlide().getTimeline().getMainSequence().getEffectsByShape(masterShape);
 } finally {
     if (pres != null) pres.dispose();
 }

A null is returned if the current shape is not inherited.

Interface IShape

Method Summary

Methods inherited from interface com.aspose.slides.ISlideComponent

Methods inherited from interface com.aspose.slides.IPresentationComponent

Methods inherited from interface com.aspose.slides.IHyperlinkContainer

Method Detail

isTextHolder

getPlaceholder

addPlaceholder

removePlaceholder

getCustomData

getRawFrame

setRawFrame

getFrame

setFrame

getLineFormat

getThreeDFormat

getEffectFormat

getFillFormat

getThumbnail

getImage

getThumbnail

getImage

getHidden

setHidden

getZOrderPosition

getConnectionSiteCount

getRotation

setRotation

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getAlternativeText

setAlternativeText

getAlternativeTextTitle

setAlternativeTextTitle

getName

setName

isDecorative

setDecorative

getShapeLock

getUniqueId

getOfficeInteropShapeId

isGrouped

getBlackWhiteMode

setBlackWhiteMode

getParentGroup

writeAsSvg

writeAsSvg

getBasePlaceholder