Slide
Slide class
Represents a slide in a presentation.
createThemeEffective
| Name | Description |
|---|
| createThemeEffective() | Returns an effective theme for this slide. |
Result:
ThemeEffectiveData
equals
| Name | Description |
|---|
| 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:
| Name | Type | Description |
|---|
| slide | Slide | The IBaseSlide to compare with the current IBaseSlide. |
Result:
boolean
equals
| Name | Description |
|---|
| 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:
| Name | Type | Description |
|---|
| slide | MasterNotesSlide | The IBaseSlide to compare with the current IBaseSlide. |
Result:
boolean
equals
| Name | Description |
|---|
| 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:
| Name | Type | Description |
|---|
| slide | MasterSlide | The IBaseSlide to compare with the current IBaseSlide. |
Result:
boolean
equals
| Name | Description |
|---|
| 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:
| Name | Type | Description |
|---|
| slide | LayoutSlide | The IBaseSlide to compare with the current IBaseSlide. |
Result:
boolean
equals
| Name | Description |
|---|
| 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:
| Name | Type | Description |
|---|
| slide | MasterHandoutSlide | The IBaseSlide to compare with the current IBaseSlide. |
Result:
boolean
equals
| Name | Description |
|---|
| 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:
| Name | Type | Description |
|---|
| slide | NotesSlide | The IBaseSlide to compare with the current IBaseSlide. |
Result:
boolean
findShapeByAltText
| Name | Description |
|---|
| findShapeByAltText(String) | Finds first occurrence of a shape with the specified alternative text. |
Parameters:
| Name | Type | Description |
|---|
| altText | String | Alternative text. |
Result:
SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector
getBackground
| Name | Description |
|---|
| getBackground() | Returns slide’s background. Read-only IBackground. |
Result:
Background
getControls
| Name | Description |
|---|
| getControls() | Returns the collection of ActiveX controls on a slide. Read-only IControlCollection. |
Result:
ControlCollection
getCustomData
| Name | Description |
|---|
| getCustomData() | Returns the slide’s custom data. Read-only ICustomData. |
Result:
CustomData
| Name | Description |
|---|
| getHeaderFooterManager() | Returns HeaderFooter manager of the slide. Read-only ISlideHeaderFooterManager. |
Result:
SlideHeaderFooterManager
getHidden
| Name | Description |
|---|
| getHidden() | Determines whether the specified slide is hidden during a slide show. Read/write boolean. |
Result:
boolean
getHyperlinkQueries
| Name | Description |
|---|
| getHyperlinkQueries() | Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries. |
Result:
HyperlinkQueries
getLayoutSlide
| Name | Description |
|---|
| getLayoutSlide() | Returns or sets the layout slide for the current slide. Read/write ILayoutSlide. |
Result:
LayoutSlide
getName
| Name | Description |
|---|
| getName() | Returns or sets the name of a slide. Read/write String. |
Result:
String
getNotesSlideManager
| Name | Description |
|---|
| getNotesSlideManager() | Allow to access notes slide, add and remove it. Read-only INotesSlideManager. |
Result:
NotesSlideManager
| Name | Description |
|---|
| getParent_Immediate() | |
getPresentation
| Name | Description |
|---|
| getPresentation() | Returns IPresentation interface. Read-only IPresentation. |
Result:
Presentation
getShapes
| Name | Description |
|---|
| getShapes() | Returns the shapes of a slide. Read-only IShapeCollection. |
Result:
ShapeCollection
getShowMasterShapes
| Name | Description |
|---|
| getShowMasterShapes() | Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean. |
Result:
boolean
getShowMasterShapes
| Name | Description |
|---|
| 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
| Error | Condition |
|---|
| NotSupportedException | Thrown if set true for master slide. |
getSlide
| Name | Description |
|---|
| getSlide() | |
Result:
Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide
| Name | Description |
|---|
| getSlideComments(CommentAuthor) | Returns all slide comments added by specific author. |
Parameters:
| Name | Type | Description |
|---|
| author | CommentAuthor | Author of comments to find or null to return all comments. |
Result:
Comment, ModernComment
getSlideId
| Name | Description |
|---|
| getSlideId() | Returns the ID of a slide. Read-only long. |
Result:
long
getSlideNumber
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| getSlideShowTransition() | Returns the Transition object which contains information about how the specified slide advances during a slide show. Read-only ISlideShowTransition. |
Result:
SlideShowTransition
getThemeManager
| Name | Description |
|---|
| getThemeManager() | Returns the overriding theme manager. Read-only IOverrideThemeManager. |
Result:
LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager, SlideThemeManager
getThumbnail
| Name | Description |
|---|
| getThumbnail(float, float) | Returns a Thumbnail Bitmap object with custom scaling. |
Parameters:
| Name | 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. |
Result:
BufferedImage
getThumbnail
| Name | Description |
|---|
| getThumbnail() | Returns a Thumbnail Image object (20% of real size). |
Result:
BufferedImage
getThumbnail
| Name | Description |
|---|
| getThumbnail(Dimension) | Returns a Thumbnail Bitmap object with specified size. |
Parameters:
| Name | Type | Description |
|---|
| imageSize | Dimension | Size of the image to create. |
Result:
BufferedImage
getThumbnail
| Name | Description |
|---|
| getThumbnail(TiffOptions) | Returns a Thumbnail tiff BufferedImage object with specified parameters. |
Parameters:
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when options.NotesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull. |
getThumbnail
Parameters:
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getThumbnail
Parameters:
| Name | Type | Description |
|---|
| notesCommentsLayouting | NotesCommentsLayoutingOptions | 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. |
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getThumbnail
Parameters:
| Name | Type | Description |
|---|
| notesCommentsLayouting | NotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| imageSize | Dimension | Size of the image to create. |
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getThumbnail
| Name | Description |
|---|
| getThumbnail(RenderingOptions) | Returns a Thumbnail BufferedImage object. |
Parameters:
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getThumbnail
| Name | Description |
|---|
| getThumbnail(RenderingOptions, float, float) | Returns a Thumbnail BufferedImage object with custom scaling. |
Parameters:
| Name | Type | Description |
|---|
| options | RenderingOptions | 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. |
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getThumbnail
| Name | Description |
|---|
| getThumbnail(RenderingOptions, Dimension) | Returns a Thumbnail BufferedImage object with specified size. |
Parameters:
| Name | Type | Description |
|---|
| options | RenderingOptions | Rendering options. |
| imageSize | Dimension | Size of the image to create. |
Result:
BufferedImage
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when options.NotesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getTimeline
| Name | Description |
|---|
| getTimeline() | Returns animation timeline object. Read-only IAnimationTimeLine. |
Result:
AnimationTimeLine
| Name | Description |
|---|
| joinPortionsWithSameFormatting() | Joins runs with same formatting in all paragraphs in all acceptable shapes. |
| Name | Description |
|---|
| joinPortionsWithSameFormatting() | Joins runs with same formatting in all paragraphs all acceptable shapes. |
| Name | Description |
|---|
| joinPortionsWithSameFormatting(ShapeCollection) | Joins runs with same formatting in all paragraphs in all acceptable shapes. |
remove
| Name | Description |
|---|
| remove() | Removes slide from presentation. |
Error
| Error | Condition |
|---|
| PptxEditException | Thrown if slide is already removed from presentation. |
renderToGraphics
| Name | Description |
|---|
| renderToGraphics(NotesCommentsLayoutingOptions, Graphics2D, int, int) | Renders certain slide to a Graphics object using specified size. |
Parameters:
| Name | Type | Description |
|---|
| notesCommentsLayouting | NotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| graphics | 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. |
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
renderToGraphics
| Name | Description |
|---|
| renderToGraphics(NotesCommentsLayoutingOptions, Graphics2D, float) | Renders certain slide to a Graphics object using specified scale. |
Parameters:
| Name | Type | Description |
|---|
| notesCommentsLayouting | NotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| graphics | Graphics2D | The object where to render to. |
| scale | float | The scale for rendering the slide (1.0 is 100%). |
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
renderToGraphics
Parameters:
| Name | Type | Description |
|---|
| notesCommentsLayouting | NotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| graphics | Graphics2D | The object where to render to. |
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
renderToGraphics
| Name | Description |
|---|
| renderToGraphics(RenderingOptions, Graphics2D) | Renders certain slide to a Graphics object. |
Parameters:
| Name | Type | Description |
|---|
| options | RenderingOptions | Rendering options. |
| graphics | Graphics2D | The object where to render to. |
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
renderToGraphics
| Name | Description |
|---|
| renderToGraphics(RenderingOptions, Graphics2D, float, float) | Renders certain slide to a Graphics object with custom scaling. |
Parameters:
| Name | Type | Description |
|---|
| options | RenderingOptions | Rendering options. |
| graphics | 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. |
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
renderToGraphics
| Name | Description |
|---|
| renderToGraphics(RenderingOptions, Graphics2D, Dimension) | Renders certain slide to a Graphics object using specified size. |
Parameters:
| Name | Type | Description |
|---|
| options | RenderingOptions | Rendering options. |
| graphics | Graphics2D | The object where to render to. |
| renderingSize | Dimension | The maximum dimensions (in pixels) that can be occupied by the rendered slide. |
Error
| Error | Condition |
|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
reset
| Name | Description |
|---|
| reset() | Resets position, size and formatting of every shape that has a prototype on LayoutSlide. |
setHidden
| Name | Description |
|---|
| setHidden(boolean) | Determines whether the specified slide is hidden during a slide show. Read/write boolean. |
setLayoutSlide
| Name | Description |
|---|
| setLayoutSlide(LayoutSlide) | Returns or sets the layout slide for the current slide. Read/write ILayoutSlide. |
setName
| Name | Description |
|---|
| setName(String) | Returns or sets the name of a slide. Read/write String. |
setShowMasterShapes
| Name | Description |
|---|
| setShowMasterShapes(boolean) | Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean. |
setShowMasterShapes
| Name | Description |
|---|
| 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
| Error | Condition |
|---|
| NotSupportedException | Thrown if set true for master slide. |
setSlideNumber
| Name | Description |
|---|
| 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
| Name | Description |
|---|
| writeAsSvgToBytes () | Saves content of slide as SVG file. |
Result:
Bytes[]
writeAsSvgToBytes
| Name | Description |
|---|
| writeAsSvgToBytes (SVGOptions) | Saves content of slide as SVG file. |
Parameters:
| Name | Type | Description |
|---|
| svgOptions | SVGOptions | SVG generation options |
Result:
Bytes[]