Packages

com.aspose.slides

Interfaces

Classes

Exceptions

java.lang.Object
- com.aspose.slides.Shape
- - com.aspose.slides.GraphicalObject
  - - com.aspose.slides.ZoomFrame

All Implemented Interfaces:

IGraphicalObject, IHyperlinkContainer, IPresentationComponent, IShape, ISlideComponent, IZoomFrame
```
public class ZoomFrame
extends GraphicalObject
implements IZoomFrame
```
Represents an Zoom object on a slide.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPPImage`	`getImage()` Gets or sets image for zoom object.
`int`	`getImageType()` Gets or sets the image type of a zoom object.
`boolean`	`getReturnToParent()` Gets or sets the navigation behavior in slideshow.
`boolean`	`getShowBackground()` Gets or sets value that specifies whether the Zoom will use the background of the destination slide.
`ISlide`	`getTargetSlide()` Gets or sets the slide object that the Slide Zoom object links to.
`float`	`getTransitionDuration()` Gets or sets the duration of the transition between Zoom and slide.
`void`	`setImage(IPPImage value)` Gets or sets image for zoom object.
`void`	`setImageType(int value)` Gets or sets the image type of a zoom object.
`void`	`setReturnToParent(boolean value)` Gets or sets the navigation behavior in slideshow.
`void`	`setShowBackground(boolean value)` Gets or sets value that specifies whether the Zoom will use the background of the destination slide.
`void`	`setTargetSlide(ISlide value)` Gets or sets the slide object that the Slide Zoom object links to.
`void`	`setTransitionDuration(float value)` Gets or sets the duration of the transition between Zoom and slide.

Methods inherited from class com.aspose.slides.GraphicalObject
getGraphicalObjectLock

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.IGraphicalObject
getGraphicalObjectLock

Methods inherited from interface com.aspose.slides.IShape
addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getLineFormat, getName, getOfficeInteropShapeId, getParentGroup, getPlaceholder, getRawFrame, getRotation, getShapeLock, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, 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

getImageType

public final int getImageType()

Gets or sets the image type of a zoom object. Read/write ZoomImageType. Default value: Preview

Next example demonstrates changing Image Type to Preview value. 
 In this case current image of a Zoom object changes to slide image:
  IPPImage image = pres.getImages().addImage(imageBytes);
 IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1), image);
 zoomFrame.setImageType(ZoomImageType.Preview);

Specifies whether the Zoom object is using the slide preview or a cover image.

Specified by:: getImageType in interface IZoomFrame

setImageType

public final void setImageType(int value)

Gets or sets the image type of a zoom object. Read/write ZoomImageType. Default value: Preview

Next example demonstrates changing Image Type to Preview value. 
 In this case current image of a Zoom object changes to slide image:
  IPPImage image = pres.getImages().addImage(imageBytes);
 IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1), image);
 zoomFrame.setImageType(ZoomImageType.Preview);

Specifies whether the Zoom object is using the slide preview or a cover image.

Specified by:: setImageType in interface IZoomFrame

getReturnToParent

public final boolean getReturnToParent()

Gets or sets the navigation behavior in slideshow. Read/write boolean. Default value: false

Example:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setReturnToParent(true);

True value of the property specifies return to parent navigation behavior in slideshow.

Specified by:: getReturnToParent in interface IZoomFrame

setReturnToParent

public final void setReturnToParent(boolean value)

Gets or sets the navigation behavior in slideshow. Read/write boolean. Default value: false

Example:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setReturnToParent(true);

True value of the property specifies return to parent navigation behavior in slideshow.

Specified by:: setReturnToParent in interface IZoomFrame

getTargetSlide

public final ISlide getTargetSlide()

Gets or sets the slide object that the Slide Zoom object links to. Read/write ISlide.

Next example demonstrates changing target slide and creates new image for the zoom object:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setTargetSlide(pres.getSlides().get_Item(2));

Specified by:: getTargetSlide in interface IZoomFrame

setTargetSlide

public final void setTargetSlide(ISlide value)

Gets or sets the slide object that the Slide Zoom object links to. Read/write ISlide.

Next example demonstrates changing target slide and creates new image for the zoom object:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setTargetSlide(pres.getSlides().get_Item(2));

Specified by:: setTargetSlide in interface IZoomFrame

getShowBackground

public final boolean getShowBackground()

Gets or sets value that specifies whether the Zoom will use the background of the destination slide. Read/write boolean. Default value: true

the example demonstrates removing the background of an image of a Zoom object:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setShowBackground(false);

Specified by:: getShowBackground in interface IZoomFrame

setShowBackground

public final void setShowBackground(boolean value)

Gets or sets value that specifies whether the Zoom will use the background of the destination slide. Read/write boolean. Default value: true

the example demonstrates removing the background of an image of a Zoom object:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setShowBackground(false);

Specified by:: setShowBackground in interface IZoomFrame

getImage

public final IPPImage getImage()

Gets or sets image for zoom object. Read/write IPPImage.

the example demonstrates changing an image of a Zoom object:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 IPPImage image = pres.getImages().addImage(imageBytes;
 zoomFrame.setImage(image);

Specified by:: getImage in interface IZoomFrame

setImage

public final void setImage(IPPImage value)

Gets or sets image for zoom object. Read/write IPPImage.

the example demonstrates changing an image of a Zoom object:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 IPPImage image = pres.getImages().addImage(imageBytes;
 zoomFrame.setImage(image);

Specified by:: setImage in interface IZoomFrame

getTransitionDuration

public final float getTransitionDuration()

Gets or sets the duration of the transition between Zoom and slide. Read/write float. Default value: 1.0f

the example demonstrates changing the duration of the transition between Zoom and slide:
  IZoomFrame zoomFrame = pres.getSlides().get_Item(0).getShapes().addZoomFrame(150, 20, 50, 50, pres.getSlides().get_Item(1));
 zoomFrame.setTransitionDuration(2.5f);

If not specified (TransitionDur = 0), it will use the destination slide transition and the timings associated with that transition.

Specified by:: getTransitionDuration in interface IZoomFrame

setTransitionDuration

public final void setTransitionDuration(float value)