com.aspose.slides

Class PictureFrame

java.lang.Object

com.aspose.slides.Shape

com.aspose.slides.GeometryShape

com.aspose.slides.PictureFrame

All Implemented Interfaces:

IGeometryShape, IHyperlinkContainer, IPictureFrame, IPresentationComponent, IShape, ISlideComponent

Direct Known Subclasses:

AudioFrame, VideoFrame

public class PictureFrame
extends GeometryShape
implements IPictureFrame

Represents a frame with a picture inside.

 The following examples shows how to change Audio Frame Thumbnail.
 
 Presentation presentation = new Presentation();
 try {
     ISlide slide = presentation.getSlides().get_Item(0);
     // Adds an audio frame to the slide with a specified position and size.
     FileInputStream audioStream = new FileInputStream("sample2.mp3");
     IAudioFrame audioFrame = slide.getShapes().addAudioFrameEmbedded(150, 100, 50, 50, audioStream);
     audioStream.close();
     // Adds an image to presentation resources.
     FileInputStream imageStream = new FileInputStream("eagle.jpeg");
     IPPImage audioImage = presentation.getImages().addImage(imageStream);
     imageStream.close();
     // Sets the image for the audio frame.
     audioFrame.getPictureFormat().getPicture().setImage(audioImage);
     //Saves the modified presentation to disk
     presentation.save("example_out.pptx", SaveFormat.Pptx);
 } catch(IOException e) {
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Method Summary

Modifier and Type	Method and Description
IPictureFillFormat	getPictureFormat() Returns the PictureFillFormat object for a picture frame.
IPictureFrameLock	getPictureFrameLock() Returns shape's locks.
float	getRelativeScaleHeight() Returns or sets the scale of height(relative to original picture size) of the picture frame.
float	getRelativeScaleWidth() Returns or sets the scale of width (relative to original picture size) of the picture frame.
int	getShapeType()
boolean	isCameo() Determines whether the PictureFrame is Cameo object or not.
void	setRelativeScaleHeight(float value) Returns or sets the scale of height(relative to original picture size) of the picture frame.
void	setRelativeScaleWidth(float value) Returns or sets the scale of width (relative to original picture size) of the picture frame.
void	setShapeType(int value)

Methods inherited from class com.aspose.slides.GeometryShape

createShapeElements, getAdjustments, getGeometryPaths, getShapeStyle, setGeometryPath, setGeometryPaths

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, getShapeLock, 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, setGeometryPath, setGeometryPaths

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, getShapeLock, 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

getPictureFrameLock

public final IPictureFrameLock getPictureFrameLock()

Returns shape's locks. Read-only IPictureFrameLock.

Specified by:

getPictureFrameLock in interface IPictureFrame

getShapeType

public int getShapeType()

Returns or sets the AutoShape type for a PictureFrame. There are allowable all items of the set ShapeType, except all sorts of lines:

ShapeType.Line,

ShapeType.StraightConnector1,

ShapeType.BentConnector2,

ShapeType.BentConnector3,

ShapeType.BentConnector4,

ShapeType.BentConnector5,

ShapeType.CurvedConnector2,

ShapeType.CurvedConnector3,

ShapeType.CurvedConnector4,

ShapeType.CurvedConnector5.

Read/write ShapeType.

Specified by:

getShapeType in interface IGeometryShape

Overrides:

getShapeType in class GeometryShape

setShapeType

public void setShapeType(int value)

Returns or sets the AutoShape type for a PictureFrame. There are allowable all items of the set ShapeType, except all sorts of lines:

ShapeType.Line,

ShapeType.StraightConnector1,

ShapeType.BentConnector2,

ShapeType.BentConnector3,

ShapeType.BentConnector4,

ShapeType.BentConnector5,

ShapeType.CurvedConnector2,

ShapeType.CurvedConnector3,

ShapeType.CurvedConnector4,

ShapeType.CurvedConnector5.

Read/write ShapeType.

Specified by:

setShapeType in interface IGeometryShape

Overrides:

setShapeType in class GeometryShape

getPictureFormat

public final IPictureFillFormat getPictureFormat()

Returns the PictureFillFormat object for a picture frame. Read-only IPictureFillFormat.

Specified by:

getPictureFormat in interface IPictureFrame

getRelativeScaleHeight

public final float getRelativeScaleHeight()

Returns or sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

Specified by:

getRelativeScaleHeight in interface IPictureFrame

setRelativeScaleHeight

public final void setRelativeScaleHeight(float value)

Returns or sets the scale of height(relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

Specified by:

setRelativeScaleHeight in interface IPictureFrame

getRelativeScaleWidth

public final float getRelativeScaleWidth()

Returns or sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

Specified by:

getRelativeScaleWidth in interface IPictureFrame

setRelativeScaleWidth

public final void setRelativeScaleWidth(float value)

Returns or sets the scale of width (relative to original picture size) of the picture frame. Value 1.0 corresponds to 100%. Read/write float.

Specified by:

setRelativeScaleWidth in interface IPictureFrame

isCameo

public final boolean isCameo()

Determines whether the PictureFrame is Cameo object or not. Read only boolean.