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

Modifier and Type	Method and Description
ISlideHeaderFooterManager	getHeaderFooterManager() Returns HeaderFooter manager of the slide.
boolean	getHidden() Determines whether the specified slide is hidden during a slide show.
IImage	getImage() Returns a Thumbnail Image object (20% of real size).
IImage	getImage(java.awt.Dimension imageSize) Returns an image object with specified size.
IImage	getImage(float scaleX, float scaleY) Returns an image object with custom scaling.
IImage	getImage(IRenderingOptions options) Returns a Thumbnail Bitmap object.
IImage	getImage(IRenderingOptions options, java.awt.Dimension imageSize) Returns a Thumbnail Bitmap object with specified size.
IImage	getImage(IRenderingOptions options, float scaleX, float scaleY) Returns a Thumbnail Bitmap object with custom scaling.
IImage	getImage(ITiffOptions options) Returns a Thumbnail tiff bitmap object with specified parameters.
ILayoutSlide	getLayoutSlide() Returns or sets the layout slide for the current slide.
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() Deprecated. Use GetImage method instead. The method will be removed after release of version 24.7.
java.awt.image.BufferedImage	getThumbnail(java.awt.Dimension imageSize) Deprecated. Use GetImage(Size imageSize) method instead. The method will be removed after release of version 24.7.
java.awt.image.BufferedImage	getThumbnail(float scaleX, float scaleY) Deprecated. Use GetImage(float scaleX, float scaleY) method instead. The method will be removed after release of version 24.7.
java.awt.image.BufferedImage	getThumbnail(IRenderingOptions options) Deprecated. Use GetImage(IRenderingOptions options) method instead. The method will be removed after release of version 24.7.
java.awt.image.BufferedImage	getThumbnail(IRenderingOptions options, java.awt.Dimension imageSize) Deprecated. Use GetImage(IRenderingOptions options, Size imageSize) method instead. The method will be removed after release of version 24.7.
java.awt.image.BufferedImage	getThumbnail(IRenderingOptions options, float scaleX, float scaleY) Deprecated. Use GetImage(IRenderingOptions options, float scaleX, float scaleY) method instead. The method will be removed after release of version 24.7.
java.awt.image.BufferedImage	getThumbnail(ITiffOptions options) Deprecated. Use GetImage(ITiffOptions options) method instead. The method will be removed after release of version 24.7.
void	remove() Removes slide from presentation.
void	renderToGraphics(IRenderingOptions options, java.awt.Graphics2D graphics) Deprecated. The method will be removed after release of version 24.7.
void	renderToGraphics(IRenderingOptions options, java.awt.Graphics2D graphics, java.awt.Dimension renderingSize) Deprecated. The method will be removed after release of version 24.7.
void	renderToGraphics(IRenderingOptions options, java.awt.Graphics2D graphics, float scaleX, float scaleY) Deprecated. The method will be removed after release of version 24.7.
void	reset() Resets position, size and formatting of every shape that has a prototype on LayoutSlide.
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	writeAsEmf(java.io.OutputStream stream) Saves the slide content as an EMF file.
void	writeAsSvg(java.io.OutputStream stream) Saves the slide content as an SVG file.
void	writeAsSvg(java.io.OutputStream stream, ISVGOptions svgOptions) Saves the slide content as an SVG file.

Methods inherited from interface com.aspose.slides.IBaseSlide

equals, findShapeByAltText, getBackground, getControls, getCustomData, getHyperlinkQueries, getName, getShapes, getShowMasterShapes, getSlideId, getSlideShowTransition, getTimeline, joinPortionsWithSameFormatting, setName, setShowMasterShapes

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

getHeaderFooterManager

ISlideHeaderFooterManager getHeaderFooterManager()

Returns HeaderFooter manager of the slide. Read-only ISlideHeaderFooterManager.

getSlideNumber

int getSlideNumber()

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

setSlideNumber

void setSlideNumber(int value)

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

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

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

Deprecated. Use GetImage(float scaleX, float scaleY) method instead. The method will be removed after release of version 24.7.

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 BufferedImage

getImage

IImage getImage(float scaleX,
                float scaleY)

Returns an image 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:

Image object BufferedImage

getThumbnail

@Deprecated
java.awt.image.BufferedImage getThumbnail()

Deprecated. Use GetImage method instead. The method will be removed after release of version 24.7.

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

Returns:

Bitmap object BufferedImage

getImage

IImage getImage()

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

Returns:

Image object BufferedImage

getThumbnail

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

Deprecated. Use GetImage(Size imageSize) method instead. The method will be removed after release of version 24.7.

Returns a Thumbnail Bitmap object with specified size.

Parameters:

imageSize - Size of the image to create.

Returns:

Bitmap object.

getImage

IImage getImage(java.awt.Dimension imageSize)

Returns an image object with specified size.

Parameters:

imageSize - Size of the image to create.

Returns:

Bitmap object.

getThumbnail

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

Deprecated. Use GetImage(ITiffOptions options) method instead. The method will be removed after release of version 24.7.

Returns a Thumbnail tiff bitmap object with specified parameters.

Parameters:

options - Tiff options.

Returns:

Bitmap object.

getImage

IImage getImage(ITiffOptions options)

Returns a Thumbnail tiff bitmap object with specified parameters.

Parameters:

options - Tiff options.

Returns:

Image object.

getThumbnail

@Deprecated
java.awt.image.BufferedImage getThumbnail(IRenderingOptions options)

Deprecated. Use GetImage(IRenderingOptions options) method instead. The method will be removed after release of version 24.7.

Returns a Thumbnail Bitmap object.

Parameters:

options - Rendering options.

Returns:

Bitmap objects.

getImage

IImage getImage(IRenderingOptions options)

Returns a Thumbnail Bitmap object.

Parameters:

options - Rendering options.

Returns:

Bitmap objects.

getThumbnail

@Deprecated
java.awt.image.BufferedImage getThumbnail(IRenderingOptions options,
                                                       float scaleX,
                                                       float scaleY)

Deprecated. Use GetImage(IRenderingOptions options, float scaleX, float scaleY) method instead. The method will be removed after release of version 24.7.

Returns a Thumbnail Bitmap object with custom scaling.

Parameters:

options - Rendering options.

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 objects.

getImage

IImage getImage(IRenderingOptions options,
                float scaleX,
                float scaleY)

Returns a Thumbnail Bitmap object with custom scaling.

Parameters:

options - Rendering options.

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 objects.

getThumbnail

@Deprecated
java.awt.image.BufferedImage getThumbnail(IRenderingOptions options,
                                                       java.awt.Dimension imageSize)

Deprecated. Use GetImage(IRenderingOptions options, Size imageSize) method instead. The method will be removed after release of version 24.7.

Returns a Thumbnail Bitmap object with specified size.

Parameters:

options - Rendering options.

imageSize - Size of the image to create.

Returns:

Bitmap objects.

getImage

IImage getImage(IRenderingOptions options,
                java.awt.Dimension imageSize)

Returns a Thumbnail Bitmap object with specified size.

Parameters:

options - Rendering options.

imageSize - Size of the image to create.

Returns:

Bitmap objects.

renderToGraphics

@Deprecated
void renderToGraphics(IRenderingOptions options,
                                   java.awt.Graphics2D graphics)

Deprecated. The method will be removed after release of version 24.7.

Renders certain slide to a Graphics object.

Parameters:

options - Rendering options.

graphics - The object where to render to.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

@Deprecated
void renderToGraphics(IRenderingOptions options,
                                   java.awt.Graphics2D graphics,
                                   float scaleX,
                                   float scaleY)

Deprecated. The method will be removed after release of version 24.7.

Renders certain slide to a Graphics object with custom scaling.

Parameters:

options - Rendering options.

graphics - The object where to render to.

scaleX - The scale for rendering the slide (1.0 is 100%) in the x-axis direction.

scaleY - The scale for rendering the slide (1.0 is 100%) in the y-axis direction.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

@Deprecated
void renderToGraphics(IRenderingOptions options,
                                   java.awt.Graphics2D graphics,
                                   java.awt.Dimension renderingSize)

Deprecated. The method will be removed after release of version 24.7.

Renders certain slide to a Graphics object using specified size.

Parameters:

options - Rendering options.

graphics - The object where to render to.

renderingSize - The maximum dimensions (in pixels) that can be occupied by the rendered slide.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull

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.

getNotesSlideManager

INotesSlideManager getNotesSlideManager()

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

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 the slide content as an SVG file.

Parameters:

stream - Target stream

writeAsSvg

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

Saves the slide content as an SVG file.

Parameters:

stream - Target stream

svgOptions - SVG generation options

writeAsEmf

void writeAsEmf(java.io.OutputStream stream)

Saves the slide content as an EMF file.

Parameters:

stream - Target stream

remove

void remove()

Removes slide from presentation.

Throws:

PptxEditException - Thrown if slide is already removed from presentation.

reset

void reset()

Resets position, size and formatting of every shape that has a prototype on LayoutSlide.