com.aspose.slides
Interface IShape

All Superinterfaces:
IHyperlinkContainer, IPresentationComponent, ISlideComponent
All Known Subinterfaces:
IAudioFrame, IAutoShape, IChart, IConnector, IGeometryShape, IGraphicalObject, IGroupShape, ILegacyDiagram, IOleObjectFrame, IPictureFrame, ISmartArt, ISmartArtShape, ITable, IVideoFrame
All Known Implementing Classes:
AudioFrame, AutoShape, Chart, Connector, GeometryShape, GraphicalObject, GroupShape, LegacyDiagram, OleObjectFrame, PictureFrame, Shape, SmartArt, SmartArtShape, Table, VideoFrame

public interface IShape
extends ISlideComponent, IHyperlinkContainer


Method Summary
 IPlaceholder addPlaceholder(IPlaceholder placeholderToCopyFrom)
           Adds a new placeholder if there is no and sets placeholder properties to a specified one.
 IEffectFormatEffectiveData createEffectFormatEffective()
           Creates the EffectFormatDataEx object that contains all effects applyed to a shape, included inherited.
 IFillFormatEffectiveData createFillFormatEffective()
           Creates the FillFormatDataEx object that contains all fill formatting properties for a shape, included inherited.
 ILineFormatEffectiveData createLineFormatEffective()
           Creates the LineFormatDataEx object that contains all line formatting properties for a shape, included inherited.
 IThreeDFormatEffectiveData createThreeDFormatEffective()
           Creates the ThreeDFormatDataEx object that contains volume properties and 3D transformation of a shape, included inherited.
 java.lang.String getAlternativeText()
           Returns or sets the alternative text associated with a shape.
 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 EffectFormatEx object which contains pixel effects applied to a shape.
 IFillFormat getFillFormat()
           Returns the FillFormatEx object that contains fill formatting properties for a shape.
 IShapeFrame getFrame()
           Returns or sets the shape frame's properties.
 float getHeight()
           Returns or sets the height of the shape.
 boolean getHidden()
           Determines whether the shape is hidden.
 ILineFormat getLineFormat()
           Returns the LineFormatEx object that contains line formatting properties for a shape.
 java.lang.String getName()
           Returns or sets the name of a shape.
 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 ThreeDFormatEx object that contains line formatting properties for a shape.
 java.awt.image.BufferedImage getThumbnail()
           Returns shape thumbnail.
 java.awt.image.BufferedImage getThumbnail(int bounds, float scaleX, float scaleY)
           Returns shape thumbnail.
 long getUniqueId()
           Gets unique shape identifier in presentation scope.
 float getWidth()
           Returns or sets the width of the shape.
 float getX()
           Returns or sets the x-coordinate of the upper-left corner of the shape.
 float getY()
           Returns or sets the y-coordinate of the upper-left corner of the shape.
 int getZOrderPosition()
           Returns the position of a shape in the z-order.
 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 setBlackWhiteMode(byte value)
           Property specifies how a shape will render in black-and-white display mode..
 void setFrame(IShapeFrame value)
           Returns or sets the shape frame's properties.
 void setHeight(float value)
           Returns or sets the height of the shape.
 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)
           Returns or sets the width of the shape.
 void setX(float value)
           Returns or sets the x-coordinate of the upper-left corner of the shape.
 void setY(float value)
           Returns or sets the y-coordinate of the upper-left corner of the shape.
 
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.Frame doesn't make sence in general case (particulary in case when parent GroupShape is multiple nested into other GroupShape-s). For example:


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.Frame doesn't make sence in general case (particulary in case when parent GroupShape is multiple nested into other GroupShape-s). For example:


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 LineFormatEx object that contains line formatting properties for a shape. Read-only ILineFormat.


getThreeDFormat

IThreeDFormat getThreeDFormat()

Returns the ThreeDFormatEx object that contains line formatting properties for a shape. Read-only IThreeDFormat.


getEffectFormat

IEffectFormat getEffectFormat()

Returns the EffectFormatEx object which contains pixel effects applied to a shape. Read-only IEffectFormat.


getFillFormat

IFillFormat getFillFormat()

Returns the FillFormatEx object that contains fill formatting properties for a shape. Read-only IFillFormat.


createLineFormatEffective

ILineFormatEffectiveData createLineFormatEffective()

Creates the LineFormatDataEx object that contains all line formatting properties for a shape, included inherited.

Returns:
ILineFormatEffectiveData.

createFillFormatEffective

IFillFormatEffectiveData createFillFormatEffective()

Creates the FillFormatDataEx object that contains all fill formatting properties for a shape, included inherited.

Returns:
IFillFormatEffectiveData.

createEffectFormatEffective

IEffectFormatEffectiveData createEffectFormatEffective()

Creates the EffectFormatDataEx object that contains all effects applyed to a shape, included inherited.

Returns:
IEffectFormatEffectiveData.

createThreeDFormatEffective

IThreeDFormatEffectiveData createThreeDFormatEffective()

Creates the ThreeDFormatDataEx object that contains volume properties and 3D transformation of a shape, included inherited.

Returns:
IFillFormatEffectiveData.

getThumbnail

java.awt.image.BufferedImage getThumbnail()

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

Returns:
Shape thumbnail.

getThumbnail

java.awt.image.BufferedImage getThumbnail(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()

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.


setX

void setX(float value)

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.


getY

float 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.


setY

void setY(float value)

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.


getWidth

float 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.


setWidth

void setWidth(float value)

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.


getHeight

float 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.


setHeight

void setHeight(float value)

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.


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.


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.


getShapeLock

IBaseShapeLock getShapeLock()

Returns shape's locks. Read-only IBaseShapeLock.


getUniqueId

long getUniqueId()

Gets unique shape identifier in presentation scope. Read-only long.


isGrouped

boolean isGrouped()

Determines whether the shape is grouped. Read-only boolean.


Property ParentGroup 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.



Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.