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

java.lang.Object
- com.aspose.slides.Shape

All Implemented Interfaces:

IHyperlinkContainer, IPresentationComponent, IShape, ISlideComponent

Direct Known Subclasses:

GeometryShape, GraphicalObject, GroupShape
```
public class Shape
extends java.lang.Object
implements IShape
```
Represents a shape on a slide.

Method Summary

All Methods Instance Methods Concrete 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.
`IHyperlink`	`getHyperlinkClick()` Returns or sets the hyperlink defined for mouse click.
`IHyperlinkManager`	`getHyperlinkManager()` Returns the hyperlink manager.
`IHyperlink`	`getHyperlinkMouseOver()` Returns or sets the hyperlink defined for mouse over.
`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.
`com.aspose.slides.IDOMObject`	`getParent_Immediate()` Returns Parent_Immediate object.
`IGroupShape`	`getParentGroup()` Returns parent GroupShape object if shape is grouped.
`IPlaceholder`	`getPlaceholder()` Returns the placeholder for a shape.
`IPresentation`	`getPresentation()` Returns the parent presentation of a slide.
`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.
`IBaseSlide`	`getSlide()` Returns the parent slide of a shape.
`IThreeDFormat`	`getThreeDFormat()` Returns the ThreeDFormat object that 3d effect 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_PPT.
`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`	`setHyperlinkClick(IHyperlink value)` Returns or sets the hyperlink defined for mouse click.
`void`	`setHyperlinkMouseOver(IHyperlink value)` Returns or sets the hyperlink defined for mouse over.
`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 class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isTextHolder
```
public final boolean isTextHolder()
```
Determines whether the shape is TextHolder_PPT. Read-only boolean.

Specified by:

isTextHolder in interface IShape

getPlaceholder

public final IPlaceholder getPlaceholder()

Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder.

 The following example shows how to change Text in Placeholder.
  // Instantiates a Presentation class
 Presentation pres = new Presentation("ReplacingText.pptx");
 try {
     // Accesses the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Iterates through shapes to find the placeholder
     for (IShape shp : sld.getShapes())
         if (shp.getPlaceholder() != null)
         {
             // Changes the text in each placeholder
             ((IAutoShape)shp).getTextFrame().setText("This is a Placeholder");
         }
     // Saves the presentation to disk
     pres.save("output_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to set Prompt Text in Placeholder.
  Presentation pres = new Presentation("Presentation2.pptx");
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     for (IShape shape : slide.getSlide().getShapes()) // Iterates through the slide
     {
         if (shape.getPlaceholder() != null && shape instanceof AutoShape)
         {
             String text = "";
             if (shape.getPlaceholder().getType() == PlaceholderType.CenteredTitle) // PowerPoint displays "Click to add title"
             {
                 text = "Add Title";
             }
             else if (shape.getPlaceholder().getType() == PlaceholderType.Subtitle) // Adds subtitle
             {
                 text = "Add Subtitle";
             }
             ((IAutoShape)shape).getTextFrame().setText(text);
             System.out.println("Placeholder with text: " + text);
         }
     }
     pres.save("Placeholders_PromptText.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getPlaceholder in interface IShape

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

Specified by:

removePlaceholder in interface IShape

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

Specified by:

addPlaceholder in interface IShape

Parameters:

placeholderToCopyFrom - Placeholder to copy content from.

Returns:

New getPlaceholder().

getBasePlaceholder

public final 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.

Specified by:: getBasePlaceholder in interface IShape

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

Specified by:

getCustomData in interface IShape

getRawFrame

public final 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 sence 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.{code}

Specified by:: getRawFrame in interface IShape

setRawFrame

public final 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 sence 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.{code}

Specified by:: setRawFrame in interface IShape

getFrame
```
public final 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.

Specified by:

getFrame in interface IShape

setFrame
```
public final 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.

Specified by:

setFrame in interface IShape

getLineFormat
```
public ILineFormat getLineFormat()
```
Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don't have line properties. Read-only ILineFormat.

Specified by:

getLineFormat in interface IShape

getThreeDFormat
```
public IThreeDFormat getThreeDFormat()
```
Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don't have 3d properties. Read-only IThreeDFormat.

Specified by:

getThreeDFormat in interface IShape

getEffectFormat
```
public IEffectFormat getEffectFormat()
```
Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don't have effect properties. Read-only IEffectFormat.

Specified by:

getEffectFormat in interface IShape

getFillFormat

public IFillFormat getFillFormat()

Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don't have fill properties. Read-only IFillFormat.

 The following example shows how to change the accent color for a theme of PowerPoint Presentation.
  Presentation pres = new Presentation();
 try {
     IAutoShape shape = pres.getSlides().get_Item(0).getShapes().addAutoShape(ShapeType.Rectangle, 10, 10, 100, 100);
     shape.getFillFormat().setFillType(FillType.Solid);
     shape.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example demonstrates how to obtain palette colors from the main theme color and then used in shapes.
  Presentation pres = new Presentation();
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     // Accent 4
     IShape shape1 = slide.getShapes().addAutoShape(ShapeType.Rectangle, 10, 10, 50, 50);
     shape1.getFillFormat().setFillType(FillType.Solid);
     shape1.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
     // Accent 4, Lighter 80%
     IShape shape2 = slide.getShapes().addAutoShape(ShapeType.Rectangle, 10, 70, 50, 50);
     shape2.getFillFormat().setFillType(FillType.Solid);
     shape2.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
     shape2.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.MultiplyLuminance, 0.2f);
     shape2.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.AddLuminance, 0.8f);
     // Accent 4, Lighter 60%
     IShape shape3 = slide.getShapes().addAutoShape(ShapeType.Rectangle, 10, 130, 50, 50);
     shape3.getFillFormat().setFillType(FillType.Solid);
     shape3.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
     shape3.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.MultiplyLuminance, 0.4f);
     shape3.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.AddLuminance, 0.6f);
     // Accent 4, Lighter 40%
     IShape shape4 = slide.getShapes().addAutoShape(ShapeType.Rectangle, 10, 190, 50, 50);
     shape4.getFillFormat().setFillType(FillType.Solid);
     shape4.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
     shape4.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.MultiplyLuminance, 0.6f);
     shape4.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.AddLuminance, 0.4f);
     // Accent 4, Darker 25%
     IShape shape5 = slide.getShapes().addAutoShape(ShapeType.Rectangle, 10, 250, 50, 50);
     shape5.getFillFormat().setFillType(FillType.Solid);
     shape5.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
     shape5.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.MultiplyLuminance, 0.75f);
     // Accent 4, Darker 50%
     IShape shape6 = slide.getShapes().addAutoShape(ShapeType.Rectangle, 10, 310, 50, 50);
     shape6.getFillFormat().setFillType(FillType.Solid);
     shape6.getFillFormat().getSolidFillColor().setSchemeColor(SchemeColor.Accent4);
     shape6.getFillFormat().getSolidFillColor().getColorTransform().add(ColorTransformOperation.MultiplyLuminance, 0.5f);
     pres.save("example_accent4.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }

Specified by:: getFillFormat in interface IShape

getThumbnail
```
@Deprecated
public final 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.

Specified by:

getThumbnail in interface IShape

Returns:

Shape thumbnail.

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

Specified by:

getImage in interface IShape

Returns:

Shape thumbnail.

getThumbnail
```
@Deprecated
public final 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.

Specified by:

getThumbnail in interface IShape

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
```
public final IImage getImage(int bounds,
                             float scaleX,
                             float scaleY)
```
Returns shape thumbnail.

Specified by:

getImage in interface IShape

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.

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

Specified by:

writeAsSvg in interface IShape

Parameters:

stream - Target stream

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

Specified by:

writeAsSvg in interface IShape

Parameters:

stream - Target stream

svgOptions - SVG generation options

getHyperlinkClick
```
public final IHyperlink getHyperlinkClick()
```
Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Specified by:

getHyperlinkClick in interface IHyperlinkContainer

setHyperlinkClick
```
public final void setHyperlinkClick(IHyperlink value)
```
Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.

Specified by:

setHyperlinkClick in interface IHyperlinkContainer

getHyperlinkMouseOver
```
public final IHyperlink getHyperlinkMouseOver()
```
Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Specified by:

getHyperlinkMouseOver in interface IHyperlinkContainer

setHyperlinkMouseOver
```
public final void setHyperlinkMouseOver(IHyperlink value)
```
Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.

Specified by:

setHyperlinkMouseOver in interface IHyperlinkContainer

getHyperlinkManager
```
public final IHyperlinkManager getHyperlinkManager()
```
Returns the hyperlink manager. Read-only IHyperlinkManager.

Specified by:

getHyperlinkManager in interface IHyperlinkContainer

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

Specified by:

getHidden in interface IShape

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

Specified by:

setHidden in interface IShape

getZOrderPosition
```
public 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.

Specified by:

getZOrderPosition in interface IShape

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

Specified by:

getConnectionSiteCount in interface IShape

getRotation
```
public final 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.

Specified by:

getRotation in interface IShape

setRotation
```
public final 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.

Specified by:

setRotation in interface IShape

getX
```
public final 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.

Specified by:

getX in interface IShape

setX
```
public final 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.

Specified by:

setX in interface IShape

getY
```
public final 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.

Specified by:

getY in interface IShape

setY
```
public final 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.

Specified by:

setY in interface IShape

getWidth
```
public final 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.

Specified by:

getWidth in interface IShape

setWidth
```
public final 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.

Specified by:

setWidth in interface IShape

getHeight
```
public final 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.

Specified by:

getHeight in interface IShape

setHeight
```
public final 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.

Specified by:

setHeight in interface IShape

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

Specified by:

getBlackWhiteMode in interface IShape

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

Specified by:

setBlackWhiteMode in interface IShape

getUniqueId
```
public final 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().

Specified by:

getUniqueId in interface IShape

getOfficeInteropShapeId
```
public final 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().

Specified by:

getOfficeInteropShapeId in interface IShape

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

Specified by:

getAlternativeText in interface IShape

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

Specified by:

setAlternativeText in interface IShape

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

Specified by:

getAlternativeTextTitle in interface IShape

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

Specified by:

setAlternativeTextTitle in interface IShape

getName
```
public final java.lang.String getName()
```
Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

Specified by:

getName in interface IShape

setName
```
public final void setName(java.lang.String value)
```
Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String.

Specified by:

setName in interface IShape

isDecorative

public final 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();
 }

Specified by:: isDecorative in interface IShape

setDecorative

public final 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();
 }

Specified by:: setDecorative in interface IShape

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

Specified by:

getShapeLock in interface IShape

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

Specified by:

isGrouped in interface IShape

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

Specified by:

getParentGroup in interface IShape

getParent_Immediate
```
public final com.aspose.slides.IDOMObject getParent_Immediate()
```
Returns Parent_Immediate object. Read-only IDOMObject.

getSlide
```
public final IBaseSlide getSlide()
```
Returns the parent slide of a shape. Read-only IBaseSlide.

Specified by:

getSlide in interface ISlideComponent

getPresentation
```
public final IPresentation getPresentation()
```
Returns the parent presentation of a slide. Read-only IPresentation.

Specified by:

getPresentation in interface IPresentationComponent

Class Shape

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isTextHolder

getPlaceholder

removePlaceholder

addPlaceholder

getBasePlaceholder

getCustomData

getRawFrame

setRawFrame

getFrame

setFrame

getLineFormat

getThreeDFormat

getEffectFormat

getFillFormat

getThumbnail

getImage

getThumbnail

getImage

writeAsSvg

writeAsSvg

getHyperlinkClick

setHyperlinkClick

getHyperlinkMouseOver

setHyperlinkMouseOver

getHyperlinkManager

getHidden

setHidden

getZOrderPosition

getConnectionSiteCount

getRotation

setRotation

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getBlackWhiteMode

setBlackWhiteMode

getUniqueId

getOfficeInteropShapeId

getAlternativeText

setAlternativeText

getAlternativeTextTitle

setAlternativeTextTitle

getName

setName

isDecorative

setDecorative

getShapeLock

isGrouped

getParentGroup

getParent_Immediate

getSlide

getPresentation