com.spire.presentation
Interface IAutoShape

All Superinterfaces:

IShape

public interface IAutoShape
extends IShape

Method Summary

void	appendTextFrame(java.lang.String text) Adds a new TextFrame to a shape.
void	dispose() Dispose object and free resources.
ShapeAdjustCollection	getAdjustments()
java.lang.String	getAlternativeText() Gets the alternative text associated with a shape.
ClickHyperlink	getClick() Gets the hyperlink defined for mouse click.
EffectDag	getEffectDag() Gets the EffectFormat object which contains pixel effects applied to a shape.
FillFormat	getFill() Gets the FillFormat object that contains fill formatting properties for a shape.
GraphicFrame	getFrame() Gets or sets the shape frame's properties.
float	getHeight() Gets the height of the shape.
float	getLeft() Gets the x-coordinate of the upper-left corner of the shape.
TextLineFormat	getLine() Gets the LineFormat object that contains line formatting properties for a shape.
ShapeLocking	getLocking() Gets shape's locks.
ClickHyperlink	getMouseOver() Gets the hyperlink defined for mouse over.
java.lang.String	getName() Gets the name of a shape.
ActiveSlide	getParent() Gets the parent slide of a shape.
PlaceholderEx	getPlaceholder() Gets the placeholder for a shape.
Presentation	getPresentation()
float	getRotation() Gets the number of degrees the specified shape is rotated.
ShapeStyleEx	getShapeStyle()
ShapeType	getShapeType()
ActiveSlide	getSlide() Gets the parent slide of a shape.
TagCollection	getTagsList() Gets the shape's tags collection.
ITextFrameProperties	getTextFrame() Gets TextFrame object for the AutoShape.
FormatThreeD	getThreeD() Gets the ThreeDFormat object that 3d effect properties for a shape Read-only .
float	getTop() Gets the y-coordinate of the upper-left corner of the shape.
boolean	getUseBackgroundFill() Indicates whether this autoshape should be filled with slide's background fill instead of specified by style or fill format.
float	getWidth() Gets the width of the shape.
int	getZOrderPosition() Gets the position of a shape in the z-order.
boolean	isHidden() Indicates whether the shape is hidden.
void	isHidden(boolean value)
boolean	isTextBox() Indicates whether the shape is TextHolder.
void	removePlaceholder() Removes placeholder from the shape.
void	setAlternativeText(java.lang.String value) sets the alternative text associated with a shape.
void	setClick(ClickHyperlink value) Sets the hyperlink defined for mouse click.
void	setFrame(GraphicFrame value) Sets the shape frame's properties.
void	setHeight(float value) Sets the height of the shape.
void	setLeft(double value) Sets the x-coordinate of the upper-left corner of the shape.
void	setMouseOver(ClickHyperlink value) Sets the hyperlink defined for mouse over.
void	setName(java.lang.String value) Sets the name of a shape.
void	setRotation(float value) Sets the number of degrees the specified shape is rotated.
void	setShapeType(ShapeType value)
void	setTop(double value) Sets the y-coordinate of the upper-left corner of the shape.
void	setUseBackgroundFill(boolean value)
void	setWidth(float value) Sets the width of the shape.

Methods inherited from interface com.spire.presentation.IShape

getAlternativeTitle, insertChart, insertPicture, insertSmartArt, insertTable, insertVideo, setAlternativeTitle, setShapeAlignment, setShapeArrange

Method Detail

getLocking

ShapeLocking getLocking()

Gets shape's locks. Read-only .

Returns:

getTextFrame

ITextFrameProperties getTextFrame()

Gets TextFrame object for the AutoShape. Read-only .

Returns:

getUseBackgroundFill

boolean getUseBackgroundFill()

Indicates whether this autoshape should be filled with slide's background fill instead of specified by style or fill format. Read/write bool.

Returns:

setUseBackgroundFill

void setUseBackgroundFill(boolean value)

getShapeStyle

ShapeStyleEx getShapeStyle()

getShapeType

ShapeType getShapeType()

setShapeType

void setShapeType(ShapeType value)

getAdjustments

ShapeAdjustCollection getAdjustments()

isTextBox

boolean isTextBox()

Indicates whether the shape is TextHolder. Read-only .

Specified by:

isTextBox in interface IShape

Returns:

getPlaceholder

PlaceholderEx getPlaceholder()

Gets the placeholder for a shape. Read-only .

Specified by:

getPlaceholder in interface IShape

Returns:

getTagsList

TagCollection getTagsList()

Gets the shape's tags collection. Read-only .

Specified by:

getTagsList in interface IShape

Returns:

getFrame

GraphicFrame getFrame()

Gets or sets the shape frame's properties. Read/write .

Specified by:

getFrame in interface IShape

Returns:

setFrame

void setFrame(GraphicFrame value)

Description copied from interface: IShape

Sets the shape frame's properties. Read/write .

Specified by:

setFrame in interface IShape

getLine

TextLineFormat getLine()

Gets the LineFormat object that contains line formatting properties for a shape. Read-only .

Specified by:

getLine in interface IShape

Returns:

getThreeD

FormatThreeD getThreeD()

Gets the ThreeDFormat object that 3d effect properties for a shape Read-only .

Specified by:

getThreeD in interface IShape

Returns:

getEffectDag

EffectDag getEffectDag()

Gets the EffectFormat object which contains pixel effects applied to a shape. can return null for certain types of shapes which don't have effect properties. Read-only

Specified by:

getEffectDag in interface IShape

Returns:

getFill

FillFormat getFill()

Gets the FillFormat object that contains fill formatting properties for a shape. Read-only .

Specified by:

getFill in interface IShape

Returns:

getClick

ClickHyperlink getClick()

Gets the hyperlink defined for mouse click. Read/write .

Specified by:

getClick in interface IShape

Returns:

setClick

void setClick(ClickHyperlink value)

Sets the hyperlink defined for mouse click. Read/write .

Specified by:

setClick in interface IShape

getMouseOver

ClickHyperlink getMouseOver()

Gets the hyperlink defined for mouse over. Read/write .

Specified by:

getMouseOver in interface IShape

Returns:

setMouseOver

void setMouseOver(ClickHyperlink value)

Sets the hyperlink defined for mouse over. Read/write .

Specified by:

setMouseOver in interface IShape

isHidden

boolean isHidden()

Indicates whether the shape is hidden. Read/write .

Specified by:

isHidden in interface IShape

Returns:

isHidden

void isHidden(boolean value)

Specified by:

isHidden in interface IShape

getParent

ActiveSlide getParent()

Gets the parent slide of a shape. Read-only .

Specified by:

getParent in interface IShape

Returns:

getZOrderPosition

int getZOrderPosition()

Gets the position of a shape in the z-order. Read-only .

Specified by:

getZOrderPosition in interface IShape

Returns:

getRotation

float getRotation()

Gets the number of degrees the specified shape is rotated. Read/write .

Specified by:

getRotation in interface IShape

Returns:

setRotation

void setRotation(float value)

Sets the number of degrees the specified shape is rotated. Read/write .

Specified by:

setRotation in interface IShape

getLeft

float getLeft()

Gets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getLeft in interface IShape

Returns:

setLeft

void setLeft(double value)

Sets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setLeft in interface IShape

getTop

float getTop()

Gets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getTop in interface IShape

Returns:

setTop

void setTop(double value)

Sets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setTop in interface IShape

getWidth

float getWidth()

Gets the width of the shape. Read/write .

Specified by:

getWidth in interface IShape

Returns:

setWidth

void setWidth(float value)

Sets the width of the shape. Read/write .

Specified by:

setWidth in interface IShape

getHeight

float getHeight()

Gets the height of the shape. Read/write .

Specified by:

getHeight in interface IShape

Returns:

setHeight

void setHeight(float value)

Sets the height of the shape. Read/write .

Specified by:

setHeight in interface IShape

getAlternativeText

java.lang.String getAlternativeText()

Gets the alternative text associated with a shape. Read/write .

Specified by:

getAlternativeText in interface IShape

Returns:

setAlternativeText

void setAlternativeText(java.lang.String value)

sets the alternative text associated with a shape. Read/write .

Specified by:

setAlternativeText in interface IShape

getName

java.lang.String getName()

Gets the name of a shape. Read/write .

Specified by:

getName in interface IShape

Returns:

setName

void setName(java.lang.String value)

Sets the name of a shape. Read/write .

Specified by:

setName in interface IShape

getSlide

ActiveSlide getSlide()

Gets the parent slide of a shape. Read-only .

Specified by:

getSlide in interface IShape

Returns:

getPresentation

Presentation getPresentation()

Specified by:

getPresentation in interface IShape

appendTextFrame

void appendTextFrame(java.lang.String text)
                     throws DocumentEditException

Adds a new TextFrame to a shape. If shape already has TextFrame then simply changes its text.

Parameters:

text - Default text for a new TextFrame.

Throws:

DocumentEditException

removePlaceholder

void removePlaceholder()

Removes placeholder from the shape.

Specified by:

removePlaceholder in interface IShape

dispose

void dispose()

Dispose object and free resources.

Specified by:

dispose in interface IShape