Slide

Inheritance: java.lang.Object, com.aspose.slides.BaseSlide

All Implemented Interfaces: com.aspose.slides.ISlide

public final class Slide extends BaseSlide implements ISlide

Represents a slide in a presentation.

Methods

Method	Description
getHeaderFooterManager()	Returns HeaderFooter manager of the slide.
getThemeManager()	Returns the overriding theme manager.
getSlideNumber()	Returns a number of slide.
setSlideNumber(int value)	Returns a number of slide.
getHidden()	Determines whether the specified slide is hidden during a slide show.
setHidden(boolean value)	Determines whether the specified slide is hidden during a slide show.
getShowMasterShapes()	Specifies if shapes on the master slide should be shown on slides or not.
setShowMasterShapes(boolean value)	Specifies if shapes on the master slide should be shown on slides or not.
getThumbnail(float scaleX, float scaleY)	Returns a Thumbnail Bitmap object with custom scaling.
getThumbnail()	Returns a Thumbnail Image object (20% of real size).
getThumbnail(Dimension imageSize)	Returns a Thumbnail Bitmap object with specified size.
getThumbnail(ITiffOptions options)	Returns a Thumbnail tiff BufferedImage object with specified parameters.
getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting)	Returns a Thumbnail BufferedImage object.
getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY)	Returns a Thumbnail BufferedImage object with custom scaling.
getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, Dimension imageSize)	Returns a Thumbnail BufferedImage object with specified size.
getThumbnail(IRenderingOptions options)	Returns a Thumbnail BufferedImage object.
getThumbnail(IRenderingOptions options, float scaleX, float scaleY)	Returns a Thumbnail BufferedImage object with custom scaling.
getThumbnail(IRenderingOptions options, Dimension imageSize)	Returns a Thumbnail BufferedImage object with specified size.
renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, int width, int height)	Renders certain slide to a Graphics object using specified size.
renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, float scale)	Renders certain slide to a Graphics object using specified scale.
renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics)	Renders certain slide to a Graphics object.
renderToGraphics(IRenderingOptions options, Graphics2D graphics)	Renders certain slide to a Graphics object.
renderToGraphics(IRenderingOptions options, Graphics2D graphics, float scaleX, float scaleY)	Renders certain slide to a Graphics object with custom scaling.
renderToGraphics(IRenderingOptions options, Graphics2D graphics, Dimension renderingSize)	Renders certain slide to a Graphics object using specified size.
writeAsSvg(OutputStream stream)	Saves content of slide as SVG file.
writeAsSvg(OutputStream stream, ISVGOptions svgOptions)	Saves content of slide as SVG file.
remove()	Removes slide from presentation.
getLayoutSlide()	Returns or sets the layout slide for the current slide.
setLayoutSlide(ILayoutSlide value)	Returns or sets the layout slide for the current slide.
reset()	Resets position, size and formatting of every shape that has a prototype on LayoutSlide.
getNotesSlideManager()	Allow to access notes slide, add and remove it.
getSlideComments(ICommentAuthor author)	Returns all slide comments added by specific author.
joinPortionsWithSameFormatting()	Joins runs with same formatting in all paragraphs in all acceptable shapes.

getHeaderFooterManager()

public final ISlideHeaderFooterManager getHeaderFooterManager()

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

Returns: ISlideHeaderFooterManager

getThemeManager()

public final IOverrideThemeManager getThemeManager()

Returns the overriding theme manager. Read-only IOverrideThemeManager.

Returns: IOverrideThemeManager

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.

Returns: int

setSlideNumber(int value)

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.

Parameters:

Parameter	Type	Description
value	int

getHidden()

public final boolean getHidden()

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

Returns: boolean

setHidden(boolean value)

public final void setHidden(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getShowMasterShapes()

public boolean getShowMasterShapes()

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

Returns: boolean

setShowMasterShapes(boolean value)

public void setShowMasterShapes(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getThumbnail(float scaleX, float scaleY)

public final BufferedImage getThumbnail(float scaleX, float scaleY)

Returns a Thumbnail Bitmap object with custom scaling.

The following example shows how to generate thumbnails from PowerPoint Presentation.
 
 // Instantiate a Presentation class that represents the presentation file
 Presentation pres = new Presentation("ThumbnailFromSlide.pptx");
 try {
     // Access the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Create a full scale image
     BufferedImage bmp = sld.getThumbnail(1f, 1f);
     // Save the image to disk in PNG format
     ImageIO.write(bmp, "PNG", new File("Thumbnail_out.png"));
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to converting slides to bitmap and saving the images in PNG.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try
 {
     for (ISlide slide : pres.getSlides())
     {
         // Converts the slide in the presentation to a Bitmap object
         BufferedImage bmp = slide.getThumbnail();
         // Saves the image in the PNG format
         ImageIO.write(bmp, "PNG", new File("Thumbnail_out_" + slide.getSlideNumber() + ".png"));
     }
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to convert PowerPoint PPT/PPTX to JPG.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try
 {
     for (ISlide slide : pres.getSlides())
     {
         // Converts the slide in the presentation to a Bitmap object
         BufferedImage bmp = slide.getThumbnail();
         // Saves the image in the JPG format
         ImageIO.write(bmp, "JPG", new File("Thumbnail_out" + slide.getSlideNumber() + ".jpg"));
     }
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to convert PowerPoint PPT/PPTX to JPG with customized dimensions.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try
 {
     // Define dimensions
     int desiredX = 1200;
     int desiredY = 800;
     // Get scaled values of X and Y
     float ScaleX = (float)(1.0 / pres.getSlideSize().getSize().getWidth()) * desiredX;
     float ScaleY = (float)(1.0 / pres.getSlideSize().getSize().getHeight()) * desiredY;
     for (ISlide slide : pres.getSlides())
     {
         // Converts the first slide in the presentation to a Bitmap object
         BufferedImage bmp = slide.getThumbnail(ScaleX, ScaleY);
         // Saves the image in the JPG format
         ImageIO.write(bmp, "JPG", new File("Slide_" + slide.getSlideNumber() + ".jpg"));
     }
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
scaleX	float	The value by which to scale this Thumbnail in the x-axis direction.
scaleY	float	The value by which to scale this Thumbnail in the y-axis direction.

Returns: java.awt.image.BufferedImage - Bitmap object.

getThumbnail()

public final BufferedImage getThumbnail()

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

Returns: java.awt.image.BufferedImage

getThumbnail(Dimension imageSize)

public final BufferedImage getThumbnail(Dimension imageSize)

Returns a Thumbnail Bitmap object with specified size.

The following example shows how to converting slides to images with custom sizes using Java.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     // Converts the first slide in the presentation to a Bitmap with the specified size
     BufferedImage bmp = pres.getSlides().get_Item(0).getThumbnail(new Dimension(1820, 1040));
     // Saves the image in the JPEG format
     ImageIO.write(bmp, "JPG", new File("Slide_0.jpg"));
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
imageSize	java.awt.Dimension	Size of the image to create.

Returns: java.awt.image.BufferedImage - Bitmap object.

getThumbnail(ITiffOptions options)

public final BufferedImage getThumbnail(ITiffOptions options)

Returns a Thumbnail tiff BufferedImage object with specified parameters.

Parameters:

Parameter	Type	Description
options	ITiffOptions	Tiff options.

Returns: java.awt.image.BufferedImage - BufferedImage object.

getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting)

public final BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting)

Returns a Thumbnail BufferedImage object.

Parameters:

Parameter	Type	Description
notesCommentsLayouting	INotesCommentsLayoutingOptions	Options for notes and comments layouting.

Returns: java.awt.image.BufferedImage - BufferedImage objects.

getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY)

public final BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY)

Returns a Thumbnail BufferedImage object with custom scaling.

Parameters:

Parameter	Type	Description
notesCommentsLayouting	INotesCommentsLayoutingOptions	Options for notes and comments layouting.
scaleX	float	The value by which to scale this Thumbnail in the x-axis direction.
scaleY	float	The value by which to scale this Thumbnail in the y-axis direction.

Returns: java.awt.image.BufferedImage - BufferedImage objects.

getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, Dimension imageSize)

public final BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, Dimension imageSize)

Returns a Thumbnail BufferedImage object with specified size.

Parameters:

Parameter	Type	Description
notesCommentsLayouting	INotesCommentsLayoutingOptions	Options for notes and comments layouting.
imageSize	java.awt.Dimension	Size of the image to create.

Returns: java.awt.image.BufferedImage - BufferedImage objects.

getThumbnail(IRenderingOptions options)

public final BufferedImage getThumbnail(IRenderingOptions options)

Returns a Thumbnail BufferedImage object.

Parameters:

Parameter	Type	Description
options	IRenderingOptions	Rendering options.

Returns: java.awt.image.BufferedImage - BufferedImage objects.

getThumbnail(IRenderingOptions options, float scaleX, float scaleY)

public final BufferedImage getThumbnail(IRenderingOptions options, float scaleX, float scaleY)

Returns a Thumbnail BufferedImage object with custom scaling.

The following example shows how to converting slides With notes and comments to Images using Java.
 
 Presentation pres = new Presentation("PresentationNotesComments.pptx");
 try {
     // Creates the rendering options
     IRenderingOptions options = new RenderingOptions();
     // Sets the position of the notes on the page
     options.getNotesCommentsLayouting().setNotesPosition(NotesPositions.BottomTruncated);
     // Sets the position of the comments on the page
     options.getNotesCommentsLayouting().setCommentsPosition(CommentsPositions.Right);
     // Sets the width of the comment output area
     options.getNotesCommentsLayouting().setCommentsAreaWidth(500);
     // Sets the color for the comments area
     options.getNotesCommentsLayouting().setCommentsAreaColor(Color.WHITE);
     // Converts the first slide of the presentation to a Bitmap object
     BufferedImage bmp = pres.getSlides().get_Item(0).getThumbnail(options, 2f, 2f);
     // Saves the image in the GIF format
     ImageIO.write(bmp, "GIF", new File("Slide_Notes_Comments_0.gif"));
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
options	IRenderingOptions	Rendering options.
scaleX	float	The value by which to scale this Thumbnail in the x-axis direction.
scaleY	float	The value by which to scale this Thumbnail in the y-axis direction.

Returns: java.awt.image.BufferedImage - BufferedImage objects.

getThumbnail(IRenderingOptions options, Dimension imageSize)

public final BufferedImage getThumbnail(IRenderingOptions options, Dimension imageSize)

Returns a Thumbnail BufferedImage object with specified size.

Parameters:

Parameter	Type	Description
options	IRenderingOptions	Rendering options.
imageSize	java.awt.Dimension	Size of the image to create.

Returns: java.awt.image.BufferedImage - BufferedImage objects.

renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, int width, int height)

public final void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, int width, int height)

Renders certain slide to a Graphics object using specified size.

Parameters:

Parameter	Type	Description
notesCommentsLayouting	INotesCommentsLayoutingOptions	Options for notes and comments layouting.
graphics	java.awt.Graphics2D	The object where to render to.
width	int	The maximum width (in pixels) that can be occupied by the rendered slide.
height	int	The maximum height (in pixels) that can be occupied by the rendered slide.

renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, float scale)

public final void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, float scale)

Renders certain slide to a Graphics object using specified scale.

Parameters:

Parameter	Type	Description
notesCommentsLayouting	INotesCommentsLayoutingOptions	Options for notes and comments layouting.
graphics	java.awt.Graphics2D	The object where to render to.
scale	float	The scale for rendering the slide (1.0 is 100%).

renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics)

public final void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics)

Renders certain slide to a Graphics object.

The following example shows how to convert the first slide of a PowerPoint presentation to a bitmap object using the RenderToGraphics method.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     // Gets the presentation slide size
     Dimension2D slideSize = pres.getSlideSize().getSize();
     // Creates a Bitmap with the slide size
     BufferedImage image = new BufferedImage((int)slideSize.getWidth(), (int)slideSize.getHeight(), BufferedImage.TYPE_INT_ARGB);
     java.awt.Graphics graphics = image.createGraphics();
     try
     {
         pres.getSlides().get_Item(0).renderToGraphics(new RenderingOptions(), (Graphics2D) graphics);
     }
     finally
     {
         if (graphics != null) graphics.dispose();
     }
     ImageIO.write(image, "PNG", new File("Slide_0.png"));
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
notesCommentsLayouting	INotesCommentsLayoutingOptions	Options for notes and comments layouting.
graphics	java.awt.Graphics2D	The object where to render to.

renderToGraphics(IRenderingOptions options, Graphics2D graphics)

public final void renderToGraphics(IRenderingOptions options, Graphics2D graphics)

Renders certain slide to a Graphics object.

Parameters:

Parameter	Type	Description
options	IRenderingOptions	Rendering options.
graphics	java.awt.Graphics2D	The object where to render to.

renderToGraphics(IRenderingOptions options, Graphics2D graphics, float scaleX, float scaleY)

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

Renders certain slide to a Graphics object with custom scaling.

Parameters:

Parameter	Type	Description
options	IRenderingOptions	Rendering options.
graphics	java.awt.Graphics2D	The object where to render to.
scaleX	float	The scale for rendering the slide (1.0 is 100%) in the x-axis direction.
scaleY	float	The scale for rendering the slide (1.0 is 100%) in the y-axis direction.

renderToGraphics(IRenderingOptions options, Graphics2D graphics, Dimension renderingSize)

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

Renders certain slide to a Graphics object using specified size.

The following example shows how to convert the first slide to the framed image with the RenderToGraphics method.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     // Gets the presentation slide size
     Dimension slideSize = new Dimension(1820, 1040);
     // Creates a Bitmap with the slide size
     BufferedImage image = new BufferedImage((int)slideSize.getWidth() + 50, (int)slideSize.getHeight() + 50, BufferedImage.TYPE_INT_ARGB);
     java.awt.Graphics graphics = image.createGraphics();
     try
     {
         graphics.setColor(Color.RED);
         graphics.fillRect(0, 0, (int)pres.getSlideSize().getSize().getWidth(), (int)pres.getSlideSize().getSize().getHeight());
         graphics.translate(25, 25);
         pres.getSlides().get_Item(0).renderToGraphics(new RenderingOptions(), (Graphics2D) graphics);
     }
     finally
     {
         if (graphics != null) graphics.dispose();
     }
     ImageIO.write(image, "PNG", new File("Slide_0.png"));
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 The following example shows how to conversion process for a slide with notes using the RenderToGraphics.
 
 Presentation pres = new Presentation("Presentation.pptx");
 try {
     // Gets the presentation slide size
     Dimension notesSize = new Dimension((int)pres.getNotesSize().getSize().getWidth(), (int)pres.getNotesSize().getSize().getHeight());
     IRenderingOptions options = new RenderingOptions();
     // Sets the position of the notes
     options.getNotesCommentsLayouting().setNotesPosition(NotesPositions.BottomTruncated);
     // Creates a Bitmap with the slide size
     BufferedImage image = new BufferedImage((int)notesSize.getWidth(), (int)notesSize.getHeight(), BufferedImage.TYPE_INT_ARGB);
     java.awt.Graphics graphics = image.createGraphics();
     try
     {
         graphics.setColor(Color.RED);
         graphics.fillRect(0, 0, (int)pres.getSlideSize().getSize().getWidth(), (int)pres.getSlideSize().getSize().getHeight());
         graphics.translate(25, 25);
         pres.getSlides().get_Item(0).renderToGraphics(options, (Graphics2D) graphics, notesSize);
     }
     finally
     {
         if (graphics != null) graphics.dispose();
     }
     ImageIO.write(image, "PNG", new File("Slide_0.png"));
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
options	IRenderingOptions	Rendering options.
graphics	java.awt.Graphics2D	The object where to render to.
renderingSize	java.awt.Dimension	The maximum dimensions (in pixels) that can be occupied by the rendered slide.

writeAsSvg(OutputStream stream)

public final void writeAsSvg(OutputStream stream)

Saves content of slide as SVG file.

The following example shows how to convert PowerPoint to PDF with custom options.
 
 // Presentation object can load PowerPoint formats like PPT, PPTX, ODP etc.
 Presentation pres = new Presentation("pres.pptx");
 try {
     for (int index = 0; index < pres.getSlides().size(); index++)
     {
         ISlide slide = pres.getSlides().get_Item(index);
         FileOutputStream fileStream = new FileOutputStream("slide-" + index + ".svg");
         try {
             slide.writeAsSvg(fileStream);
         } finally {
             if (fileStream != null) fileStream.close();
         }
     }
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	Target stream

writeAsSvg(OutputStream stream, ISVGOptions svgOptions)

public final void writeAsSvg(OutputStream stream, ISVGOptions svgOptions)

Saves content of slide as SVG file.

The following example code shows how to generate SVG image with Custom Shape IDS from PowerPoint Presentation.
 
 // Instantiate a Presentation class that represents the presentation file
 Presentation pres = new Presentation("CreateSlidesSVGImage.pptx");
 try {
     // Access the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Create a memory stream object
     ByteArrayOutputStream svgStream = new ByteArrayOutputStream();
     // Generate SVG image of slide and save in memory stream
     sld.writeAsSvg(svgStream);
     // Save memory stream to file
     FileOutputStream fileStream = new FileOutputStream("Aspose_out.svg");
     try {
         svgStream.writeTo(fileStream);
     } finally {
         if (fileStream != null) fileStream.close();
     }
     svgStream.close();
 } catch(IOException e) { }
 finally
 {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
stream	java.io.OutputStream	Target stream
svgOptions	ISVGOptions	SVG generation options

remove()

public final void remove()

Removes slide from presentation.

getLayoutSlide()

public final ILayoutSlide getLayoutSlide()

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

Returns: ILayoutSlide

setLayoutSlide(ILayoutSlide value)

public final void setLayoutSlide(ILayoutSlide value)

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

Parameters:

Parameter	Type	Description
value	ILayoutSlide

reset()

public final void reset()

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

getNotesSlideManager()

public final INotesSlideManager getNotesSlideManager()

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

Returns: INotesSlideManager

getSlideComments(ICommentAuthor author)

public final IComment[] getSlideComments(ICommentAuthor author)

Returns all slide comments added by specific author.

Parameters:

Parameter	Type	Description
author	ICommentAuthor	Author of comments to find or null to return all comments.

Returns: com.aspose.slides.IComment[] - Array of Comment.

joinPortionsWithSameFormatting()

public void joinPortionsWithSameFormatting()

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