Slide

Slide class

Represents a slide in a presentation.

createThemeEffective

NameDescription
createThemeEffective()Returns an effective theme for this slide.

Result: ThemeEffectiveData


equals

NameDescription
equals(Slide)Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

NameTypeDescription
slideSlideThe IBaseSlide to compare with the current IBaseSlide.

Result: boolean


equals

NameDescription
equals(MasterNotesSlide)Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

NameTypeDescription
slideMasterNotesSlideThe IBaseSlide to compare with the current IBaseSlide.

Result: boolean


equals

NameDescription
equals(MasterSlide)Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

NameTypeDescription
slideMasterSlideThe IBaseSlide to compare with the current IBaseSlide.

Result: boolean


equals

NameDescription
equals(LayoutSlide)Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

NameTypeDescription
slideLayoutSlideThe IBaseSlide to compare with the current IBaseSlide.

Result: boolean


equals

NameDescription
equals(MasterHandoutSlide)Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

NameTypeDescription
slideMasterHandoutSlideThe IBaseSlide to compare with the current IBaseSlide.

Result: boolean


equals

NameDescription
equals(NotesSlide)Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

NameTypeDescription
slideNotesSlideThe IBaseSlide to compare with the current IBaseSlide.

Result: boolean


findShapeByAltText

NameDescription
findShapeByAltText(String)Finds first occurrence of a shape with the specified alternative text.

Parameters:

NameTypeDescription
altTextStringAlternative text.

Result: SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector


getBackground

NameDescription
getBackground()Returns slide’s background. Read-only IBackground.

Result: Background


getControls

NameDescription
getControls()Returns the collection of ActiveX controls on a slide. Read-only IControlCollection.

Result: ControlCollection


getCustomData

NameDescription
getCustomData()Returns the slide’s custom data. Read-only ICustomData.

Result: CustomData


getHeaderFooterManager

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

Result: SlideHeaderFooterManager


getHidden

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

Result: boolean


getHyperlinkQueries

NameDescription
getHyperlinkQueries()Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries.

Result: HyperlinkQueries


getLayoutSlide

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

Result: LayoutSlide


getName

NameDescription
getName()Returns or sets the name of a slide. Read/write String.

Result: String


getNotesSlideManager

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

Result: NotesSlideManager


getParent_Immediate

NameDescription
getParent_Immediate()

getPresentation

NameDescription
getPresentation()Returns IPresentation interface. Read-only IPresentation.

Result: Presentation


getShapes

NameDescription
getShapes()Returns the shapes of a slide. Read-only IShapeCollection.

Result: ShapeCollection


getShowMasterShapes

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

Result: boolean


getShowMasterShapes

NameDescription
getShowMasterShapes()Specifies if shapes on the master slide should be shown on slides or not. For master slide itself this property always returns false. Read/write boolean.

Result: boolean

Error

ErrorCondition
NotSupportedExceptionThrown if set true for master slide.

getSlide

NameDescription
getSlide()

Result: Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide


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.

Result: Comment, ModernComment


getSlideId

NameDescription
getSlideId()Returns the ID of a slide. Read-only long.

Result: long


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.

Result: int


getSlideShowTransition

NameDescription
getSlideShowTransition()Returns the Transition object which contains information about how the specified slide advances during a slide show. Read-only ISlideShowTransition.

Result: SlideShowTransition


getThemeManager

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

Result: LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager, SlideThemeManager


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.

Result: BufferedImage


getThumbnail

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

Result: BufferedImage


getThumbnail

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

Parameters:

NameTypeDescription
imageSizeDimensionSize of the image to create.

Result: BufferedImage


getThumbnail

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

Parameters:

NameTypeDescription
optionsTiffOptionsTiff options.

Result: BufferedImage

Error

ErrorCondition
InvalidOperationExceptionThrown when options.NotesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull.

getThumbnail

NameDescription
getThumbnail(NotesCommentsLayoutingOptions)Returns a Thumbnail BufferedImage object.

Parameters:

NameTypeDescription
notesCommentsLayoutingNotesCommentsLayoutingOptionsOptions for notes and comments layouting.

Result: BufferedImage

Error

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

getThumbnail

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

Parameters:

NameTypeDescription
notesCommentsLayoutingNotesCommentsLayoutingOptionsOptions for notes and comments layouting.
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.

Result: BufferedImage

Error

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

getThumbnail

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

Parameters:

NameTypeDescription
notesCommentsLayoutingNotesCommentsLayoutingOptionsOptions for notes and comments layouting.
imageSizeDimensionSize of the image to create.

Result: BufferedImage

Error

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

getThumbnail

NameDescription
getThumbnail(RenderingOptions)Returns a Thumbnail BufferedImage object.

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.

Result: BufferedImage

Error

ErrorCondition
InvalidOperationExceptionThrown when notesCommentsLayouting.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.

Result: BufferedImage

Error

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.

Result: BufferedImage

Error

ErrorCondition
InvalidOperationExceptionThrown when options.NotesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull

getTimeline

NameDescription
getTimeline()Returns animation timeline object. Read-only IAnimationTimeLine.

Result: AnimationTimeLine


joinPortionsWithSameFormatting

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

joinPortionsWithSameFormatting

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

joinPortionsWithSameFormatting

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

remove

NameDescription
remove()Removes slide from presentation.

Error

ErrorCondition
PptxEditExceptionThrown if slide is already removed from presentation.

renderToGraphics

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

Parameters:

NameTypeDescription
notesCommentsLayoutingNotesCommentsLayoutingOptionsOptions for notes and comments layouting.
graphicsGraphics2DThe object where to render to.
widthintThe maximum width (in pixels) that can be occupied by the rendered slide.
heightintThe maximum height (in pixels) that can be occupied by the rendered slide.

Error

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

renderToGraphics

NameDescription
renderToGraphics(NotesCommentsLayoutingOptions, Graphics2D, float)Renders certain slide to a Graphics object using specified scale.

Parameters:

NameTypeDescription
notesCommentsLayoutingNotesCommentsLayoutingOptionsOptions for notes and comments layouting.
graphicsGraphics2DThe object where to render to.
scalefloatThe scale for rendering the slide (1.0 is 100%).

Error

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

renderToGraphics

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

Parameters:

NameTypeDescription
notesCommentsLayoutingNotesCommentsLayoutingOptionsOptions for notes and comments layouting.
graphicsGraphics2DThe object where to render to.

Error

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

renderToGraphics

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

Parameters:

NameTypeDescription
optionsRenderingOptionsRendering options.
graphicsGraphics2DThe object where to render to.

Error

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.

Error

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.

Error

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.

setHidden

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

setLayoutSlide

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

setName

NameDescription
setName(String)Returns or sets the name of a slide. Read/write String.

setShowMasterShapes

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

setShowMasterShapes

NameDescription
setShowMasterShapes(boolean)Specifies if shapes on the master slide should be shown on slides or not. For master slide itself this property always returns false. Read/write boolean.

Error

ErrorCondition
NotSupportedExceptionThrown if set true for master slide.

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.

writeAsSvgToBytes

NameDescription
writeAsSvgToBytes ()Saves content of slide as SVG file.

Result: Bytes[]


writeAsSvgToBytes

NameDescription
writeAsSvgToBytes (SVGOptions)Saves content of slide as SVG file.

Parameters:

NameTypeDescription
svgOptionsSVGOptionsSVG generation options

Result: Bytes[]