com.aspose.slides

Class AutoShape

java.lang.Object

com.aspose.slides.Shape

com.aspose.slides.GeometryShape

com.aspose.slides.AutoShape

All Implemented Interfaces:

IAutoShape, IGeometryShape, IHyperlinkContainer, IPresentationComponent, IShape, ISlideComponent

public final class AutoShape
extends GeometryShape
implements IAutoShape

Represents an AutoShape.

Method Summary

Modifier and Type	Method and Description
ITextFrame	addTextFrame(java.lang.String text) Adds a new TextFrame to a shape.
IAutoShapeLock	getAutoShapeLock() Returns autoshape's locks.
IAutoShapeLock	getShapeLock() Returns shape's locks.
ITextFrame	getTextFrame() Returns TextFrame object for the AutoShape.
boolean	getUseBackgroundFill() Determines whether this autoshape should be filled with slide's background fill instead of specified by style or fill format.
boolean	isTextBox() Specifies if the shape is a text box.
void	setUseBackgroundFill(boolean value) Determines whether this autoshape should be filled with slide's background fill instead of specified by style or fill format.

Methods inherited from class com.aspose.slides.GeometryShape

createShapeElements, getAdjustments, getGeometryPaths, getShapeStyle, getShapeType, setGeometryPath, setGeometryPaths, setShapeType

Methods inherited from class com.aspose.slides.Shape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParent_Immediate, getParentGroup, getPlaceholder, getPresentation, getRawFrame, getRotation, getSlide, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, setFrame, setHeight, setHidden, setHyperlinkClick, setHyperlinkMouseOver, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.IGeometryShape

createShapeElements, getAdjustments, getGeometryPaths, getShapeStyle, getShapeType, setGeometryPath, setGeometryPaths, setShapeType

Methods inherited from interface com.aspose.slides.IShape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParentGroup, getPlaceholder, getRawFrame, getRotation, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, setFrame, setHeight, setHidden, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

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

getShapeLock

public final IAutoShapeLock getShapeLock()

Returns shape's locks. Read-only IAutoShapeLock.

Specified by:

getShapeLock in interface IShape

Overrides:

getShapeLock in class Shape

getAutoShapeLock

public final IAutoShapeLock getAutoShapeLock()

Returns autoshape's locks. Read-only IAutoShapeLock.

Specified by:

getAutoShapeLock in interface IAutoShape

getTextFrame

public final ITextFrame getTextFrame()

Returns TextFrame object for the AutoShape. Read-only ITextFrame.

Specified by:

getTextFrame in interface IAutoShape

getUseBackgroundFill

public final boolean getUseBackgroundFill()

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

Specified by:

getUseBackgroundFill in interface IAutoShape

setUseBackgroundFill

public final void setUseBackgroundFill(boolean value)

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

Specified by:

setUseBackgroundFill in interface IAutoShape

addTextFrame

public final ITextFrame addTextFrame(java.lang.String text)

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

 The following sample code shows how to add watermark text in PowerPoint Presentation.
 
 Presentation pres = new Presentation();
 try {
     ISlide slide = pres.getSlides().get_Item(0);
     IAutoShape watermarkShape = slide.getShapes().addAutoShape(ShapeType.Triangle, 0, 0, 150, 50);
     ITextFrame watermarkTextFrame = watermarkShape.addTextFrame("Watermark");
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to create Text Box on Slide.
 
 // Instantiates Presentation
 Presentation pres = new Presentation();
 try {
     // Gets the first slide in the presentation
     ISlide sld = pres.getSlides().get_Item(0);
     // Adds an AutoShape with type set as Rectangle
     IAutoShape ashp = sld.getShapes().addAutoShape(ShapeType.Rectangle, 150, 75, 150, 50);
     // Adds TextFrame to the Rectangle
     ashp.addTextFrame(" ");
     // Accesses the text frame
     ITextFrame txtFrame = ashp.getTextFrame();
     // Creates the Paragraph object for text frame
     IParagraph para = txtFrame.getParagraphs().get_Item(0);
     // Creates a Portion object for the paragraph
     IPortion portion = para.getPortions().get_Item(0);
     // Sets the text
     portion.setText("Aspose TextBox");
     // Saves the presentation to disk
     pres.save("TextBox_out.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to add column in Text Box.
 
 Presentation pres = new Presentation();
 try {
     // Gets the first slide in the presentation
     ISlide slide = pres.getSlides().get_Item(0);
     // Add an AutoShape with type set as Rectangle
     IAutoShape aShape = slide.getShapes().addAutoShape(ShapeType.Rectangle, 100, 100, 300, 300);
     // Add TextFrame to the Rectangle
     aShape.addTextFrame("All these columns are limited to be within a single text container -- " +
     "you can add or delete text and the new or remaining text automatically adjusts " +
     "itself to flow within the container. You cannot have text flow from one container " +
     "to other though -- we told you PowerPoint's column options for text are limited!");
     // Gets the text format of TextFrame
     ITextFrameFormat format = aShape.getTextFrame().getTextFrameFormat();
     // Specifies the number of columns in TextFrame
     format.setColumnCount(3);
     // Specifies the spacing between columns
     format.setColumnSpacing(10);
     // Saves the presentation
     pres.save("ColumnCount.pptx", SaveFormat.Pptx);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

addTextFrame in interface IAutoShape

Parameters:

text - Default text for a new TextFrame.

Returns:

New ITextFrame object.

isTextBox

public final boolean isTextBox()

Specifies if the shape is a text box.

If shape is not specified to be a text box does not mean that it cannot have text attached to it. A text box is merely a specialized shape with specific properties.

Specified by:

isTextBox in interface IAutoShape