Shape
Shape class
Represents a shape on a slide.
addPlaceholder
| Name | Description |
|---|---|
| addPlaceholder (Placeholder) | Adds a new placeholder if there is no and sets placeholder properties to a specified one. |
Parameters:
| Name | Type | Description |
|---|---|---|
| placeholderToCopyFrom | Placeholder | Placeholder to copy content from. |
Returns: Placeholder
getAlternativeText
| Name | Description |
|---|---|
| getAlternativeText () | Returns or sets the alternative text associated with a shape. Read/write String. |
Returns: String
getAlternativeTextTitle
| Name | Description |
|---|---|
| getAlternativeTextTitle () | Returns or sets the title of alternative text associated with a shape. Read/write String. |
Returns: String
getBasePlaceholder
| Name | Description |
|---|---|
| getBasePlaceholder () | Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from). A null is returned if the current shape is not inherited. |
Returns: Connector, GraphicalObject, Table, SmartArtShape, Shape, Ink, SummaryZoomFrame, GeometryShape, ZoomFrame, SummaryZoomSection, OleObjectFrame, VideoFrame, SmartArt, GroupShape, AutoShape, SectionZoomFrame, PictureFrame, Chart, AudioFrame, LegacyDiagram, ZoomObject
getBlackWhiteMode
| Name | Description |
|---|---|
| getBlackWhiteMode () | Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode. |
Returns: byte
getConnectionSiteCount
| Name | Description |
|---|---|
| getConnectionSiteCount () | Returns the number of connection sites on the shape. Read-only int. |
Returns: int
getCustomData
| Name | Description |
|---|---|
| getCustomData () | Returns the shape’s custom data. Read-only ICustomData. |
Returns: CustomData
getEffectFormat
| Name | Description |
|---|---|
| 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. |
Returns: EffectFormat
getFillFormat
| Name | Description |
|---|---|
| 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. |
Returns: FillFormat
getFrame
| Name | Description |
|---|---|
| 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. |
Returns: ShapeFrame
getHeight
| Name | Description |
|---|---|
| getHeight () | Returns or sets the height of the shape. 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. |
Returns: float
getHidden
| Name | Description |
|---|---|
| getHidden () | Determines whether the shape is hidden. Read/write boolean. |
Returns: boolean
getHyperlinkClick
| Name | Description |
|---|---|
| getHyperlinkClick () | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
Returns: Hyperlink
getHyperlinkManager
| Name | Description |
|---|---|
| getHyperlinkManager () | Returns the hyperlink manager. Read-only IHyperlinkManager. |
Returns: HyperlinkManager
getHyperlinkMouseOver
| Name | Description |
|---|---|
| getHyperlinkMouseOver () | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
Returns: Hyperlink
getImage
| Name | Description |
|---|---|
| getImage () | Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default. |
Returns: IImage
getImage
| Name | Description |
|---|---|
| getImage (int, float, float) | Returns shape thumbnail. |
Parameters:
| Name | Type | Description |
|---|---|---|
| bounds | int | Shape thumbnail bounds type. |
| scaleX | float | X scale |
| scaleY | float | Y scale |
Returns: IImage
getLineFormat
| Name | Description |
|---|---|
| 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. |
Returns: LineFormat
getName
| Name | Description |
|---|---|
| getName () | Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String. |
Returns: String
getOfficeInteropShapeId
| Name | Description |
|---|---|
| getOfficeInteropShapeId () | Gets unique shape identifier in slide scope. Read-only long. See also ( #getUniqueId) for getting unique shape identifier in presentation scope. |
Returns: long
getParentGroup
| Name | Description |
|---|---|
| getParentGroup () | Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. Property ( #isGrouped) determines whether the shape is grouped. |
Returns: GroupShape
getPlaceholder
| Name | Description |
|---|---|
| getPlaceholder () | Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder. |
Returns: Placeholder
getPresentation
| Name | Description |
|---|---|
| getPresentation () | Returns the parent presentation of a slide. Read-only IPresentation. |
Returns: Presentation
getRawFrame
| Name | Description |
|---|---|
| getRawFrame () | Returns or sets the raw shape frame’s properties. Read/write IShapeFrame. |
Returns: ShapeFrame
getRotation
| Name | Description |
|---|---|
| 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. |
Returns: float
getShapeLock
| Name | Description |
|---|---|
| getShapeLock () | Returns shape’s locks. Read-only IBaseShapeLock. |
Returns: GraphicalObjectLock, ConnectorLock, AutoShapeLock, PictureFrameLock, BaseShapeLock, GroupShapeLock
getSlide
| Name | Description |
|---|---|
| getSlide () | Returns the parent slide of a shape. Read-only IBaseSlide. |
Returns: MasterHandoutSlide, BaseSlide, LayoutSlide, Slide, MasterSlide, NotesSlide, MasterNotesSlide
getThreeDFormat
| Name | Description |
|---|---|
| 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. |
Returns: ThreeDFormat
getThumbnail
| Name | Description |
|---|---|
| getThumbnail () | Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default. |
Returns: BufferedImage
getThumbnail
| Name | Description |
|---|---|
| getThumbnail (int, float, float) | Returns shape thumbnail. |
Parameters:
| Name | Type | Description |
|---|---|---|
| bounds | int | Shape thumbnail bounds type. |
| scaleX | float | X scale |
| scaleY | float | Y scale |
Returns: BufferedImage
getUniqueId
| Name | Description |
|---|---|
| getUniqueId () | Gets unique shape identifier in presentation scope. Read-only long. See also ( #getOfficeInteropShapeId) for getting unique shape identifier in slide scope. |
Returns: long
getWidth
| Name | Description |
|---|---|
| getWidth () | Returns or sets the width of the shape. 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. |
Returns: float
getX
| Name | Description |
|---|---|
| getX () | Returns or sets the x-coordinate of the upper-left corner of the shape. 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. |
Returns: float
getY
| Name | Description |
|---|---|
| getY () | Returns or sets the y-coordinate of the upper-left corner of the shape. 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. |
Returns: float
getZOrderPosition
| Name | Description |
|---|---|
| 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. |
Returns: int
isDecorative
| Name | Description |
|---|---|
| isDecorative () | Gets or sets ‘Mark as decorative’ option Reed/write boolean. |
Returns: boolean
isGrouped
| Name | Description |
|---|---|
| isGrouped () | Determines whether the shape is grouped. Read-only boolean. Property ( #getParentGroup) returns parent GroupShape object if shape is grouped. |
Returns: boolean
isTextHolder
| Name | Description |
|---|---|
| isTextHolder () | Determines whether the shape is TextHolder_PPT. Read-only boolean. |
Returns: boolean
removePlaceholder
| Name | Description |
|---|---|
| removePlaceholder () | Defines that this shape isn’t a placeholder. |
Returns: void
setAlternativeText
| Name | Description |
|---|---|
| setAlternativeText (String) | Returns or sets the alternative text associated with a shape. Read/write String. |
Returns: void
setAlternativeTextTitle
| Name | Description |
|---|---|
| setAlternativeTextTitle (String) | Returns or sets the title of alternative text associated with a shape. Read/write String. |
Returns: void
setBlackWhiteMode
| Name | Description |
|---|---|
| setBlackWhiteMode (byte) | Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode. |
Returns: void
setDecorative
| Name | Description |
|---|---|
| setDecorative (boolean) | Gets or sets ‘Mark as decorative’ option Reed/write boolean. |
Returns: void
setFrame
| Name | Description |
|---|---|
| setFrame (ShapeFrame) | 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. |
Returns: void
setHeight
| Name | Description |
|---|---|
| setHeight (float) | Returns or sets the height of the shape. 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. |
Returns: void
setHidden
| Name | Description |
|---|---|
| setHidden (boolean) | Determines whether the shape is hidden. Read/write boolean. |
Returns: void
setHyperlinkClick
| Name | Description |
|---|---|
| setHyperlinkClick (Hyperlink) | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
Returns: void
setHyperlinkMouseOver
| Name | Description |
|---|---|
| setHyperlinkMouseOver (Hyperlink) | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
Returns: void
setName
| Name | Description |
|---|---|
| setName (String) | Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String. |
Returns: void
setRawFrame
| Name | Description |
|---|---|
| setRawFrame (ShapeFrame) | Returns or sets the raw shape frame’s properties. Read/write IShapeFrame. |
Returns: void
setRotation
| Name | Description |
|---|---|
| setRotation (float) | 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. |
Returns: void
setWidth
| Name | Description |
|---|---|
| setWidth (float) | Returns or sets the width of the shape. 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. |
Returns: void
setX
| Name | Description |
|---|---|
| setX (float) | Returns or sets the x-coordinate of the upper-left corner of the shape. 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. |
Returns: void
setY
| Name | Description |
|---|---|
| setY (float) | Returns or sets the y-coordinate of the upper-left corner of the shape. 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. |
Returns: void
writeAsSvg
| Name | Description |
|---|---|
| writeAsSvg (OutputStream) | Saves content of Shape as SVG file. |
Parameters:
| Name | Type | Description |
|---|---|---|
| stream | OutputStream | Target stream |
Returns: void
writeAsSvg
| Name | Description |
|---|---|
| writeAsSvg (OutputStream, SVGOptions) | Saves content of Shape as SVG file. |
Parameters:
| Name | Type | Description |
|---|---|---|
| stream | OutputStream | Target stream |
| svgOptions | SVGOptions | SVG generation options |
Returns: void