Slide

Slide class

Represents a slide in a presentation.

getHeaderFooterManager

NameDescription
getHeaderFooterManager ()Returns HeaderFooter manager of the slide. Read-only ISlideHeaderFooterManager.

Returns: SlideHeaderFooterManager


getHidden

NameDescription
getHidden ()Determines whether the specified slide is hidden during a slide show. Read/write boolean.

Returns: boolean


getImage

NameDescription
getImage (float, float)Returns a Thumbnail Image object with custom scaling.

Parameters:

NameTypeDescription
scaleXfloatThe value by which to scale this Thumbnail in the x-axis direction.
scaleYfloatThe value by which to scale this Thumbnail in the y-axis direction.

Returns: IImage


getImage

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

Returns: IImage


getImage

NameDescription
getImage (Dimension)Returns a Thumbnail Image object with specified size.

Parameters:

NameTypeDescription
imageSizeDimensionSize of the image to create.

Returns: IImage


getImage

NameDescription
getImage (TiffOptions)Returns a Thumbnail tiff image object with specified parameters.

Parameters:

NameTypeDescription
optionsTiffOptionsTiff options.

Returns: IImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull.

getImage

NameDescription
getImage (RenderingOptions)Returns a Thumbnail Image object.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.

Returns: IImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getImage

NameDescription
getImage (RenderingOptions, float, float)Returns a Thumbnail Image object with custom scaling.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
scaleXfloatThe value by which to scale this Thumbnail in the x-axis direction.
scaleYfloatThe value by which to scale this Thumbnail in the y-axis direction.

Returns: IImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getImage

NameDescription
getImage (RenderingOptions, Dimension)Returns a Thumbnail Image object with specified size.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
imageSizeDimensionSize of the image to create.

Returns: IImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull.

getLayoutSlide

NameDescription
getLayoutSlide ()Returns or sets the layout slide for the current slide. Read/write ILayoutSlide.

Returns: LayoutSlide


getNotesSlideManager

NameDescription
getNotesSlideManager ()Allow to access notes slide, add and remove it. Read-only INotesSlideManager.

Returns: NotesSlideManager


getShowMasterShapes

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

Returns: boolean


getSlideComments

NameDescription
getSlideComments (CommentAuthor)Returns all slide comments added by specific author.

Parameters:

NameTypeDescription
authorCommentAuthorAuthor of comments to find or null to return all comments.

Returns: Comment, ModernComment


getSlideNumber

NameDescription
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


getThemeManager

NameDescription
getThemeManager ()Returns the overriding theme manager. Read-only IOverrideThemeManager.

Returns: SlideThemeManager, LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager


getThumbnail

NameDescription
getThumbnail (float, float)Returns a Thumbnail Bitmap object with custom scaling.

Parameters:

NameTypeDescription
scaleXfloatThe value by which to scale this Thumbnail in the x-axis direction.
scaleYfloatThe value by which to scale this Thumbnail in the y-axis direction.

Returns: BufferedImage


getThumbnail

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

Returns: BufferedImage


getThumbnail

NameDescription
getThumbnail (RenderingOptions)Returns a Thumbnail Bitmap object.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.

Returns: BufferedImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

NameDescription
getThumbnail (Dimension)Returns a Thumbnail Bitmap object with specified size.

Parameters:

NameTypeDescription
imageSizeDimensionSize of the image to create.

Returns: BufferedImage


getThumbnail

NameDescription
getThumbnail (TiffOptions)Returns a Thumbnail tiff image object with specified parameters.

Parameters:

NameTypeDescription
optionsTiffOptionsTiff options.

Returns: BufferedImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull.

getThumbnail

NameDescription
getThumbnail (RenderingOptions, float, float)Returns a Thumbnail BufferedImage object with custom scaling.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
scaleXfloatThe value by which to scale this Thumbnail in the x-axis direction.
scaleYfloatThe value by which to scale this Thumbnail in the y-axis direction.

Returns: BufferedImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getThumbnail

NameDescription
getThumbnail (RenderingOptions, Dimension)Returns a Thumbnail BufferedImage object with specified size.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
imageSizeDimensionSize of the image to create.

Returns: BufferedImage

Exception

ErrorCondition
InvalidOperationExceptionThrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull.

joinPortionsWithSameFormatting

NameDescription
joinPortionsWithSameFormatting ()Joins runs with same formatting in all paragraphs in all acceptable shapes.

Returns: void


remove

NameDescription
remove ()Removes slide from presentation.

Returns: void

Exception

ErrorCondition
PptxEditExceptionThrown if slide is already removed from presentation.

renderToGraphics

NameDescription
renderToGraphics (RenderingOptions, Graphics2D)Renders certain slide to a Graphics object.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
graphicsGraphics2DThe object where to render to.

Returns: void

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

NameDescription
renderToGraphics (RenderingOptions, Graphics2D, float, float)Renders certain slide to a Graphics object with custom scaling.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
graphicsGraphics2DThe object where to render to.
scaleXfloatThe scale for rendering the slide (1.0 is 100%) in the x-axis direction.
scaleYfloatThe scale for rendering the slide (1.0 is 100%) in the y-axis direction.

Returns: void

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

renderToGraphics

NameDescription
renderToGraphics (RenderingOptions, Graphics2D, Dimension)Renders certain slide to a Graphics object using specified size.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
graphicsGraphics2DThe object where to render to.
renderingSizeDimensionThe maximum dimensions (in pixels) that can be occupied by the rendered slide.

Returns: void

Exception

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

reset

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

Returns: void


setHidden

NameDescription
setHidden (boolean)Determines whether the specified slide is hidden during a slide show. Read/write boolean.

Returns: void


setLayoutSlide

NameDescription
setLayoutSlide (LayoutSlide)Returns or sets the layout slide for the current slide. Read/write ILayoutSlide.

Returns: void


setShowMasterShapes

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

Returns: void


setSlideNumber

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

Returns: void


writeAsSvg

NameDescription
writeAsSvg (OutputStream)Saves content of slide as SVG file.

Parameters:

NameTypeDescription
streamOutputStreamTarget stream

Returns: void


writeAsSvg

NameDescription
writeAsSvg (OutputStream, SVGOptions)Saves content of slide as SVG file.

Parameters:

NameTypeDescription
streamOutputStreamTarget stream
svgOptionsSVGOptionsSVG generation options

Returns: void