com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Class Slide

    • Method Detail

      • getSlideNumber

        public final int getSlideNumber()

        Returns a number of slide. Index of slide in Presentation.Slides(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.Slides(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
      • 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.
      • 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
      • 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.