com.aspose.slides
Interface ISlide

All Superinterfaces:
IBaseSlide, IOverrideThemeable, IPresentationComponent, ISlideComponent, IThemeable
All Known Implementing Classes:
Slide

public interface ISlide
extends IBaseSlide, IOverrideThemeable

Represents a slide in a presentation.


Method Summary
 INotesSlide addNotesSlide()
          Deprecated. 
 boolean getHidden()
           Determines whether the specified slide is hidden during a slide show.
 ILayoutSlide getLayoutSlide()
           Returns or sets the layout slide for the current slide.
 INotesSlide getNotesSlide()
          Deprecated. 
 INotesSlideManager getNotesSlideManager()
           Allow to access notes slide, add and remove it.
 IComment[] getSlideComments(ICommentAuthor author)
           Returns all slide comments added by specific author.
 int getSlideNumber()
           Returns a number of slide.
 java.awt.image.BufferedImage getThumbnail()
           Returns a Thumbnail Image object (20% of real size).
 java.awt.image.BufferedImage getThumbnail(java.awt.Dimension imageSize)
           Returns a Thumbnail Bitmap object with specified size.
 java.awt.image.BufferedImage getThumbnail(float scaleX, float scaleY)
           Returns a Thumbnail Bitmap object with custom scaling.
 java.awt.image.BufferedImage getThumbnail(ITiffOptions options)
           Returns a Thumbnail tiff bitmap object with specified parameters.
 void remove()
           Removes slide from presentation.
 void renderToGraphics(boolean withNotes, java.awt.Graphics2D graphics)
           Renders certain slide to a Graphics object.
 void renderToGraphics(boolean withNotes, java.awt.Graphics2D graphics, float scale)
           Renders certain slide to a Graphics object.
 void renderToGraphics(boolean withNotes, java.awt.Graphics2D graphics, int width, int height)
           Renders certain slide to a Graphics object.
 void setHidden(boolean value)
           Determines whether the specified slide is hidden during a slide show.
 void setLayoutSlide(ILayoutSlide value)
           Returns or sets the layout slide for the current slide.
 void setSlideNumber(int value)
           Returns a number of slide.
 void writeAsSvg(java.io.OutputStream stream)
           Saves content of slide as SVG file.
 void writeAsSvg(java.io.OutputStream stream, ISVGOptions svgOptions)
           Saves content of slide as SVG file.
 
Methods inherited from interface com.aspose.slides.IBaseSlide
findShapeByAltText, getBackground, getControls, getCustomData, getHyperlinkQueries, getName, getShapes, getSlideId, getSlideShowTransition, getTimeline, joinPortionsWithSameFormatting, setName
 
Methods inherited from interface com.aspose.slides.IOverrideThemeable
getThemeManager
 
Methods inherited from interface com.aspose.slides.IThemeable
createThemeEffective
 
Methods inherited from interface com.aspose.slides.ISlideComponent
getSlide
 
Methods inherited from interface com.aspose.slides.IPresentationComponent
getPresentation
 

Method Detail

getSlideNumber

int getSlideNumber()

Returns a number of slide. Index of slide in IPresentation.Slides collection is always equal to SlideNumber - 1. Read/write .


setSlideNumber

void setSlideNumber(int value)

Returns a number of slide. Index of slide in IPresentation.Slides collection is always equal to SlideNumber - 1. Read/write .


getHidden

boolean getHidden()

Determines whether the specified slide is hidden during a slide show. Read/write boolean.


setHidden

void setHidden(boolean value)

Determines whether the specified slide is hidden during a slide show. Read/write boolean.


getThumbnail

java.awt.image.BufferedImage getThumbnail(float scaleX,
                                          float scaleY)

Returns a Thumbnail Bitmap object with custom scaling.

Parameters:
scaleX - The value by which to scale this Thumbnail in the x-axis direction.
scaleY - The value by which to scale this Thumbnail in the y-axis direction.
Returns:
Bitmap object.

getThumbnail

java.awt.image.BufferedImage getThumbnail()

Returns a Thumbnail Image object (20% of real size).


getThumbnail

java.awt.image.BufferedImage getThumbnail(java.awt.Dimension imageSize)

Returns a Thumbnail Bitmap object with specified size.

Parameters:
imageSize - Size of the image to create.
Returns:
Bitmap object.

getThumbnail

java.awt.image.BufferedImage getThumbnail(ITiffOptions options)

Returns a Thumbnail tiff bitmap object with specified parameters.

Parameters:
options - Tiff options.
Returns:
Bitmap object.

renderToGraphics

void renderToGraphics(boolean withNotes,
                      java.awt.Graphics2D graphics,
                      int width,
                      int height)

Renders certain slide to a Graphics object.

Parameters:
withNotes - True to render slide notes as well. False otherwise.
graphics - The object where to render to.
width - The maximum width (in pixels) that can be occupied by the rendered slide.
height - The maximum height (in pixels) that can be occupied by the rendered slide.

renderToGraphics

void renderToGraphics(boolean withNotes,
                      java.awt.Graphics2D graphics,
                      float scale)

Renders certain slide to a Graphics object.

Parameters:
withNotes - True to render slide notes as well. False otherwise.
graphics - The object where to render to.
scale - The scale for rendering the slide (1.0 is 100%).

renderToGraphics

void renderToGraphics(boolean withNotes,
                      java.awt.Graphics2D graphics)

Renders certain slide to a Graphics object.

Parameters:
withNotes - True to render slide notes as well. False otherwise.
graphics - The object where to render to.

getLayoutSlide

ILayoutSlide getLayoutSlide()

Returns or sets the layout slide for the current slide. Read/write ILayoutSlide.


setLayoutSlide

void setLayoutSlide(ILayoutSlide value)

Returns or sets the layout slide for the current slide. Read/write ILayoutSlide.


getNotesSlide

@Deprecated
INotesSlide getNotesSlide()
Deprecated. 

Returns the notes slide for the current slide. Returns null if slide doesn't have notes slide. Read-only INotesSlide.


addNotesSlide

@Deprecated
INotesSlide addNotesSlide()
Deprecated. 

Returns the notes slide for the current slide, creating one if there isn't.

Returns:
INotesSlide for this slide.

getNotesSlideManager

INotesSlideManager getNotesSlideManager()

Allow to access notes slide, add and remove it. Read-only .


getSlideComments

IComment[] getSlideComments(ICommentAuthor author)

Returns all slide comments added by specific author.

Parameters:
author - Author of comments to find or null to return all comments.
Returns:
Array of IComment.

writeAsSvg

void writeAsSvg(java.io.OutputStream stream)

Saves content of slide as SVG file.

Parameters:
stream - Target stream

writeAsSvg

void writeAsSvg(java.io.OutputStream stream,
                ISVGOptions svgOptions)

Saves content of slide as SVG file.

Parameters:
stream - Target stream
svgOptions - SVG generation options

remove

void remove()

Removes slide from presentation.

Throws:
PptxEditException - Thrown if slide is already removed from presentation.


Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.