|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.Shape
public class Shape
Represents a shape on a slide.
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 EffectFormatData object that contains all effects applyed to a shape, included inherited. |
IFillFormatEffectiveData |
createFillFormatEffective()
Creates the FillFormatData object that contains all fill formatting properties for a shape, included inherited. |
ILineFormatEffectiveData |
createLineFormatEffective()
Creates the LineFormatData object that contains all line formatting properties for a shape, included inherited. |
IThreeDFormatEffectiveData |
createThreeDFormatEffective()
Creates the ThreeDFormatData 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 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()
Returns or sets the height of the shape. |
boolean |
getHidden()
Determines whether the shape is hidden. |
Hyperlink |
getHLinkClick()
Deprecated. |
Hyperlink |
getHLinkMouseOver()
Deprecated. |
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. |
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. |
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. |
ITagCollection |
getTags()
Deprecated. |
IThreeDFormat |
getThreeDFormat()
Returns the ThreeDFormat object that 3d effect 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_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 |
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 |
setHLinkClick(Hyperlink value)
Deprecated. |
void |
setHLinkMouseOver(Hyperlink value)
Deprecated. |
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)
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 class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean isTextHolder()
Determines whether the shape is TextHolder_PPT.
Read-only boolean
.
isTextHolder
in interface IShape
public IPlaceholder getPlaceholder()
Returns the placeholder for a shape. Returns null if the shape has no placeholder.
Read-only IPlaceholder
.
getPlaceholder
in interface IShape
public void removePlaceholder()
Defines that this shape isn't a placeholder.
removePlaceholder
in interface IShape
public IPlaceholder addPlaceholder(IPlaceholder placeholderToCopyFrom)
Adds a new placeholder if there is no and sets placeholder properties to a specified one.
addPlaceholder
in interface IShape
placeholderToCopyFrom
- Placeholder to copy content from.
Placeholder
.@Deprecated public ITagCollection getTags()
Returns the shape's tags collection.
Read-only ITagCollection
.
public ICustomData getCustomData()
Returns the shape's custom data.
Read-only ICustomData
.
getCustomData
in interface IShape
public IShapeFrame getRawFrame()
Returns or sets the raw shape frame's properties.
Read/write IShapeFrame
.
getRawFrame
in interface IShape
public void setRawFrame(IShapeFrame value)
Returns or sets the raw shape frame's properties.
Read/write IShapeFrame
.
setRawFrame
in interface IShape
public IShapeFrame getFrame()
Returns or sets the shape frame's properties.
Read/write IShapeFrame
.
getFrame
in interface IShape
public void setFrame(IShapeFrame value)
Returns or sets the shape frame's properties.
Read/write IShapeFrame
.
setFrame
in interface IShape
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
.
getLineFormat
in interface IShape
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
.
getThreeDFormat
in interface IShape
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
.
getEffectFormat
in interface IShape
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
.
getFillFormat
in interface IShape
public ILineFormatEffectiveData createLineFormatEffective()
Creates the LineFormatData object that contains all line formatting properties for a shape, included inherited.
createLineFormatEffective
in interface IShape
LineFormatEffectiveData
.public IFillFormatEffectiveData createFillFormatEffective()
Creates the FillFormatData object that contains all fill formatting properties for a shape, included inherited.
createFillFormatEffective
in interface IShape
FillFormatEffectiveData
.public IEffectFormatEffectiveData createEffectFormatEffective()
Creates the EffectFormatData object that contains all effects applyed to a shape, included inherited.
createEffectFormatEffective
in interface IShape
EffectFormatEffectiveData
.public IThreeDFormatEffectiveData createThreeDFormatEffective()
Creates the ThreeDFormatData object that contains volume properties and 3D transformation of a shape, included inherited.
createThreeDFormatEffective
in interface IShape
FillFormatEffectiveData
.public java.awt.image.BufferedImage getThumbnail()
Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default.
getThumbnail
in interface IShape
public java.awt.image.BufferedImage getThumbnail(int bounds, float scaleX, float scaleY)
Returns shape thumbnail.
getThumbnail
in interface IShape
bounds
- Shape thumbnail bounds type.scaleX
- X scalescaleY
- Y scale
public IHyperlink getHyperlinkClick()
Returns or sets the hyperlink defined for mouse click.
Read/write IHyperlink
.
getHyperlinkClick
in interface IHyperlinkContainer
public void setHyperlinkClick(IHyperlink value)
Returns or sets the hyperlink defined for mouse click.
Read/write IHyperlink
.
setHyperlinkClick
in interface IHyperlinkContainer
@Deprecated public Hyperlink getHLinkClick()
Returns or sets the hyperlink defined for mouse click.
Read/write Hyperlink
.
@Deprecated public void setHLinkClick(Hyperlink value)
Returns or sets the hyperlink defined for mouse click.
Read/write Hyperlink
.
public IHyperlink getHyperlinkMouseOver()
Returns or sets the hyperlink defined for mouse over.
Read/write IHyperlink
.
getHyperlinkMouseOver
in interface IHyperlinkContainer
public void setHyperlinkMouseOver(IHyperlink value)
Returns or sets the hyperlink defined for mouse over.
Read/write IHyperlink
.
setHyperlinkMouseOver
in interface IHyperlinkContainer
@Deprecated public Hyperlink getHLinkMouseOver()
Returns or sets the hyperlink defined for mouse over.
Read/write Hyperlink
.
@Deprecated public void setHLinkMouseOver(Hyperlink value)
Returns or sets the hyperlink defined for mouse over.
Read/write Hyperlink
.
public IHyperlinkManager getHyperlinkManager()
Returns the hyperlink manager.
Read-only IHyperlinkManager
.
getHyperlinkManager
in interface IHyperlinkContainer
public boolean getHidden()
Determines whether the shape is hidden.
Read/write boolean
.
getHidden
in interface IShape
public void setHidden(boolean value)
Determines whether the shape is hidden.
Read/write boolean
.
setHidden
in interface IShape
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
.
getZOrderPosition
in interface IShape
public int getConnectionSiteCount()
Returns the number of connection sites on the shape.
Read-only int
.
getConnectionSiteCount
in interface IShape
public 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
.
getRotation
in interface IShape
public 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
.
setRotation
in interface IShape
public float getX()
Returns or sets the x-coordinate of the upper-left corner of the shape.
Read/write float
.
getX
in interface IShape
public void setX(float value)
Returns or sets the x-coordinate of the upper-left corner of the shape.
Read/write float
.
setX
in interface IShape
public float getY()
Returns or sets the y-coordinate of the upper-left corner of the shape.
Read/write float
.
getY
in interface IShape
public void setY(float value)
Returns or sets the y-coordinate of the upper-left corner of the shape.
Read/write float
.
setY
in interface IShape
public float getWidth()
Returns or sets the width of the shape.
Read/write float
.
getWidth
in interface IShape
public void setWidth(float value)
Returns or sets the width of the shape.
Read/write float
.
setWidth
in interface IShape
public float getHeight()
Returns or sets the height of the shape.
Read/write float
.
getHeight
in interface IShape
public void setHeight(float value)
Returns or sets the height of the shape.
Read/write float
.
setHeight
in interface IShape
public byte getBlackWhiteMode()
Property specifies how a shape will render in black-and-white display mode..
Read/write BlackWhiteMode
.
getBlackWhiteMode
in interface IShape
public void setBlackWhiteMode(byte value)
Property specifies how a shape will render in black-and-white display mode..
Read/write BlackWhiteMode
.
setBlackWhiteMode
in interface IShape
public long getUniqueId()
Gets unique shape identifier in presentation scope.
Read-only long
.
getUniqueId
in interface IShape
public java.lang.String getAlternativeText()
Returns or sets the alternative text associated with a shape.
Read/write String
.
getAlternativeText
in interface IShape
public void setAlternativeText(java.lang.String value)
Returns or sets the alternative text associated with a shape.
Read/write String
.
setAlternativeText
in interface IShape
public 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
.
getName
in interface IShape
public 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
.
setName
in interface IShape
public IBaseShapeLock getShapeLock()
Returns shape's locks.
Read-only IBaseShapeLock
.
getShapeLock
in interface IShape
public boolean isGrouped()
Determines whether the shape is grouped.
Read-only boolean
.
ParentGroup
returns parent GroupShape object if shape is grouped.
isGrouped
in interface IShape
public IGroupShape getParentGroup()
Returns parent GroupShape object if shape is grouped. Otherwise returns null.
Read-only IGroupShape
.
IsGrouped
determines whether the shape is grouped.
getParentGroup
in interface IShape
public com.aspose.slides.IDOMObject getParent_Immediate()
Returns Parent_Immediate object.
Read-only IDOMObject
.
public IBaseSlide getSlide()
Returns the parent slide of a shape.
Read-only IBaseSlide
.
getSlide
in interface ISlideComponent
public IPresentation getPresentation()
Returns the parent presentation of a slide.
Read-only IPresentation
.
getPresentation
in interface IPresentationComponent
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |