com.aspose.slides

Class Slide

java.lang.Object

com.aspose.slides.BaseSlide

com.aspose.slides.Slide

All Implemented Interfaces:

IBaseSlide, IOverrideThemeable, IPresentationComponent, ISlide, ISlideComponent, IThemeable

public final class Slide
extends BaseSlide
implements ISlide

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.
ILayoutSlide	getLayoutSlide() Returns or sets the layout slide for the current slide.
INotesSlideManager	getNotesSlideManager() Allow to access notes slide, add and remove it.
boolean	getShowMasterShapes() Specifies if shapes on the master slide should be shown on slides or not.
IComment[]	getSlideComments(ICommentAuthor author) Returns all slide comments added by specific author.
int	getSlideNumber() Returns a number of slide.
IOverrideThemeManager	getThemeManager() Returns the overriding theme manager.
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(INotesCommentsLayoutingOptions notesCommentsLayouting) Deprecated. Use Slide.getThumbnail(IRenderingOptions) instead. The method will be removed after release of version 21.4.
java.awt.image.BufferedImage	getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, java.awt.Dimension imageSize) Deprecated. Use Slide.getThumbnail(IRenderingOptions) instead. The method will be removed after release of version 21.4.
java.awt.image.BufferedImage	getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY) Deprecated. Use Slide.getThumbnail(IRenderingOptions, float, float) instead. The method will be removed after release of version 21.4.
java.awt.image.BufferedImage	getThumbnail(IRenderingOptions options) Returns a Thumbnail BufferedImage object.
java.awt.image.BufferedImage	getThumbnail(IRenderingOptions options, java.awt.Dimension imageSize) Returns a Thumbnail BufferedImage object with specified size.
java.awt.image.BufferedImage	getThumbnail(IRenderingOptions options, float scaleX, float scaleY) Returns a Thumbnail BufferedImage object with custom scaling.
java.awt.image.BufferedImage	getThumbnail(ITiffOptions options) Returns a Thumbnail tiff BufferedImage object with specified parameters.
void	joinPortionsWithSameFormatting() Joins runs with same formatting in all paragraphs in all acceptable shapes.
void	remove() Removes slide from presentation.
void	renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, java.awt.Graphics2D graphics) Deprecated. Use Slide.renderToGraphics(IRenderingOptions, Graphics) instead. The method will be removed after release of version 21.4.
void	renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, java.awt.Graphics2D graphics, float scale) Deprecated. Use Slide.renderToGraphics(IRenderingOptions, Graphics, float) instead. The method will be removed after release of version 21.4.
void	renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, java.awt.Graphics2D graphics, int width, int height) Deprecated. Use Slide.renderToGraphics(IRenderingOptions, Graphics, int, int) instead. The method will be removed after release of version 21.4.
void	renderToGraphics(IRenderingOptions options, java.awt.Graphics2D graphics) Renders certain slide to a Graphics object.
void	renderToGraphics(IRenderingOptions options, java.awt.Graphics2D graphics, java.awt.Dimension renderingSize) Renders certain slide to a Graphics object using specified size.
void	renderToGraphics(IRenderingOptions options, java.awt.Graphics2D graphics, float scaleX, float scaleY) Renders certain slide to a Graphics object with custom scaling.
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	setShowMasterShapes(boolean value) Specifies if shapes on the master slide should be shown on slides or not.
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 class com.aspose.slides.BaseSlide

createThemeEffective, equals, findShapeByAltText, getBackground, getControls, getCustomData, getHyperlinkQueries, getName, getParent_Immediate, getPresentation, getShapes, getSlide, getSlideId, getSlideShowTransition, getTimeline, joinPortionsWithSameFormatting, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspose.slides.IBaseSlide

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

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

public final ISlideHeaderFooterManager getHeaderFooterManager()

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

Specified by:

getHeaderFooterManager in interface ISlide

getThemeManager

public final IOverrideThemeManager getThemeManager()

Returns the overriding theme manager. Read-only IOverrideThemeManager.

Specified by:

getThemeManager in interface IOverrideThemeable

getSlideNumber

public final int getSlideNumber()

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

Specified by:

getSlideNumber in interface ISlide

setSlideNumber

public final void setSlideNumber(int value)

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

Specified by:

setSlideNumber in interface ISlide

getHidden

public final boolean getHidden()

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

Specified by:

getHidden in interface ISlide

setHidden

public final void setHidden(boolean value)

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

Specified by:

setHidden in interface ISlide

getShowMasterShapes

public boolean getShowMasterShapes()

Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean.

Specified by:

getShowMasterShapes in interface IBaseSlide

Specified by:

getShowMasterShapes in class BaseSlide

setShowMasterShapes

public void setShowMasterShapes(boolean value)

Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean.

Specified by:

setShowMasterShapes in interface IBaseSlide

Specified by:

setShowMasterShapes in class BaseSlide

getThumbnail

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

Returns a Thumbnail Bitmap object with custom scaling.

Specified by:

getThumbnail in interface ISlide

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

public final java.awt.image.BufferedImage getThumbnail()

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

Specified by:

getThumbnail in interface ISlide

Returns:

Bitmap object BufferedImage

getThumbnail

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

Returns a Thumbnail Bitmap object with specified size.

Specified by:

getThumbnail in interface ISlide

Parameters:

imageSize - Size of the image to create.

Returns:

Bitmap object.

getThumbnail

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

Returns a Thumbnail tiff BufferedImage object with specified parameters.

Specified by:

getThumbnail in interface ISlide

Parameters:

options - Tiff options.

Returns:

BufferedImage object.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when options.NotesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull.

getThumbnail

@Deprecated
public final java.awt.image.BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting)

Deprecated. Use Slide.getThumbnail(IRenderingOptions) instead. The method will be removed after release of version 21.4.

Returns a Thumbnail BufferedImage object.

Specified by:

getThumbnail in interface ISlide

Parameters:

notesCommentsLayouting - Options for notes and comments layouting.

Returns:

BufferedImage objects.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

@Deprecated
public final java.awt.image.BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                                    float scaleX,
                                                                    float scaleY)

Deprecated. Use Slide.getThumbnail(IRenderingOptions, float, float) instead. The method will be removed after release of version 21.4.

Returns a Thumbnail BufferedImage object with custom scaling.

Specified by:

getThumbnail in interface ISlide

Parameters:

notesCommentsLayouting - Options for notes and comments layouting.

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:

BufferedImage objects.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

@Deprecated
public final java.awt.image.BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                                    java.awt.Dimension imageSize)

Deprecated. Use Slide.getThumbnail(IRenderingOptions) instead. The method will be removed after release of version 21.4.

Returns a Thumbnail BufferedImage object with specified size.

Specified by:

getThumbnail in interface ISlide

Parameters:

notesCommentsLayouting - Options for notes and comments layouting.

imageSize - Size of the image to create.

Returns:

BufferedImage objects.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

public final java.awt.image.BufferedImage getThumbnail(IRenderingOptions options)

Returns a Thumbnail BufferedImage object.

Specified by:

getThumbnail in interface ISlide

Parameters:

options - Rendering options.

Returns:

BufferedImage objects.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

public final java.awt.image.BufferedImage getThumbnail(IRenderingOptions options,
                                                       float scaleX,
                                                       float scaleY)

Returns a Thumbnail BufferedImage object with custom scaling.

Specified by:

getThumbnail in interface ISlide

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:

BufferedImage objects.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

public final java.awt.image.BufferedImage getThumbnail(IRenderingOptions options,
                                                       java.awt.Dimension imageSize)

Returns a Thumbnail BufferedImage object with specified size.

Specified by:

getThumbnail in interface ISlide

Parameters:

options - Rendering options.

imageSize - Size of the image to create.

Returns:

BufferedImage objects.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when options.NotesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

@Deprecated
public final void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                java.awt.Graphics2D graphics,
                                                int width,
                                                int height)

Deprecated. Use Slide.renderToGraphics(IRenderingOptions, Graphics, int, int) instead. The method will be removed after release of version 21.4.

Renders certain slide to a Graphics object using specified size.

Specified by:

renderToGraphics in interface ISlide

Parameters:

notesCommentsLayouting - Options for notes and comments layouting.

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.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

@Deprecated
public final void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                java.awt.Graphics2D graphics,
                                                float scale)

Deprecated. Use Slide.renderToGraphics(IRenderingOptions, Graphics, float) instead. The method will be removed after release of version 21.4.

Renders certain slide to a Graphics object using specified scale.

Specified by:

renderToGraphics in interface ISlide

Parameters:

notesCommentsLayouting - Options for notes and comments layouting.

graphics - The object where to render to.

scale - The scale for rendering the slide (1.0 is 100%).

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

@Deprecated
public final void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                java.awt.Graphics2D graphics)

Deprecated. Use Slide.renderToGraphics(IRenderingOptions, Graphics) instead. The method will be removed after release of version 21.4.

Renders certain slide to a Graphics object.

Specified by:

renderToGraphics in interface ISlide

Parameters:

notesCommentsLayouting - Options for notes and comments layouting.

graphics - The object where to render to.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

public final void renderToGraphics(IRenderingOptions options,
                                   java.awt.Graphics2D graphics)

Renders certain slide to a Graphics object.

Specified by:

renderToGraphics in interface ISlide

Parameters:

options - Rendering options.

graphics - The object where to render to.

Throws:

com.aspose.ms.System.InvalidOperationException - Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

public final void renderToGraphics(IRenderingOptions options,
                                   java.awt.Graphics2D graphics,
                                   float scaleX,
                                   float scaleY)

Renders certain slide to a Graphics object with custom scaling.

Specified by:

renderToGraphics in interface ISlide

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 notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

public final void renderToGraphics(IRenderingOptions options,
                                   java.awt.Graphics2D graphics,
                                   java.awt.Dimension renderingSize)

Renders certain slide to a Graphics object using specified size.

Specified by:

renderToGraphics in interface ISlide

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 notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

writeAsSvg

public final void writeAsSvg(java.io.OutputStream stream)

Saves content of slide as SVG file.

Specified by:

writeAsSvg in interface ISlide

Parameters:

stream - Target stream

writeAsSvg

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

Saves content of slide as SVG file.

Specified by:

writeAsSvg in interface ISlide

Parameters:

stream - Target stream

svgOptions - SVG generation options

remove

public final void remove()

Removes slide from presentation.

Specified by:

remove in interface ISlide

Throws:

PptxEditException - Thrown if slide is already removed from presentation.

getLayoutSlide

public final ILayoutSlide getLayoutSlide()

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

Specified by:

getLayoutSlide in interface ISlide

setLayoutSlide

public final void setLayoutSlide(ILayoutSlide value)

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

Specified by:

setLayoutSlide in interface ISlide

reset

public final void reset()

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

Specified by:

reset in interface ISlide

getNotesSlideManager

public final INotesSlideManager getNotesSlideManager()

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

Specified by:

getNotesSlideManager in interface ISlide

getSlideComments

public final IComment[] getSlideComments(ICommentAuthor author)

Returns all slide comments added by specific author.

Specified by:

getSlideComments in interface ISlide

Parameters:

author - Author of comments to find or null to return all comments.

Returns:

Array of Comment.

joinPortionsWithSameFormatting

public void joinPortionsWithSameFormatting()

Joins runs with same formatting in all paragraphs in all acceptable shapes.

Specified by:

joinPortionsWithSameFormatting in interface IBaseSlide

Overrides:

joinPortionsWithSameFormatting in class BaseSlide