Slide
Slide class
Represents a slide in a presentation.
getHeaderFooterManager
| Name | Description |
|---|---|
| getHeaderFooterManager () | Returns HeaderFooter manager of the slide. Read-only ISlideHeaderFooterManager. |
Returns: SlideHeaderFooterManager
getHidden
| Name | Description |
|---|---|
| getHidden () | Determines whether the specified slide is hidden during a slide show. Read/write boolean. |
Returns: boolean
getImage
| Name | Description |
|---|---|
| getImage (float, float) | Returns a Thumbnail Image 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. |
Returns: IImage
getImage
| Name | Description |
|---|---|
| getImage () | Returns a Thumbnail Image object (20% of real size). |
Returns: IImage
getImage
| Name | Description |
|---|---|
| getImage (Dimension) | Returns a Thumbnail Image object with specified size. |
Parameters:
| Name | Type | Description |
|---|---|---|
| imageSize | Dimension | Size of the image to create. |
Returns: IImage
getImage
| Name | Description |
|---|---|
| getImage (TiffOptions) | Returns a Thumbnail tiff image object with specified parameters. |
Parameters:
| Name | Type | Description |
|---|---|---|
| options | TiffOptions | Tiff options. |
Returns: IImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull. |
getImage
| Name | Description |
|---|---|
| getImage (RenderingOptions) | Returns a Thumbnail Image object. |
Parameters:
| Name | Type | Description |
|---|---|---|
| options | RenderingOptions | Rendering options. |
Returns: IImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getImage
| Name | Description |
|---|---|
| getImage (RenderingOptions, float, float) | Returns a Thumbnail Image 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. |
Returns: IImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
getImage
| Name | Description |
|---|---|
| getImage (RenderingOptions, Dimension) | Returns a Thumbnail Image object with specified size. |
Parameters:
| Name | Type | Description |
|---|---|---|
| options | RenderingOptions | Rendering options. |
| imageSize | Dimension | Size of the image to create. |
Returns: IImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull. |
getLayoutSlide
| Name | Description |
|---|---|
| getLayoutSlide () | Returns or sets the layout slide for the current slide. Read/write ILayoutSlide. |
Returns: LayoutSlide
getNotesSlideManager
| Name | Description |
|---|---|
| getNotesSlideManager () | Allow to access notes slide, add and remove it. Read-only INotesSlideManager. |
Returns: NotesSlideManager
getShowMasterShapes
| Name | Description |
|---|---|
| getShowMasterShapes () | Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean. |
Returns: boolean
getSlideComments
| 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. |
Returns: Comment, ModernComment
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. |
Returns: int
getThemeManager
| Name | Description |
|---|---|
| getThemeManager () | Returns the overriding theme manager. Read-only IOverrideThemeManager. |
Returns: SlideThemeManager, LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager
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. |
Returns: BufferedImage
getThumbnail
| Name | Description |
|---|---|
| getThumbnail () | Returns a Thumbnail Image object (20% of real size). |
Returns: BufferedImage
getThumbnail
| Name | Description |
|---|---|
| getThumbnail (RenderingOptions) | Returns a Thumbnail Bitmap object. |
Parameters:
| Name | Type | Description |
|---|---|---|
| options | RenderingOptions | Rendering options. |
Returns: BufferedImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when notesCommentsLayouting.NotesPosition takes the value NotesPositions.BottomFull |
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. |
Returns: BufferedImage
getThumbnail
| Name | Description |
|---|---|
| getThumbnail (TiffOptions) | Returns a Thumbnail tiff image object with specified parameters. |
Parameters:
| Name | Type | Description |
|---|---|---|
| options | TiffOptions | Tiff options. |
Returns: BufferedImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property 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. |
Returns: BufferedImage
Exception
| 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. |
Returns: BufferedImage
Exception
| Error | Condition |
|---|---|
| InvalidOperationException | Thrown when options.SlideLayoutOption is NotesCommentsLayoutingOptions and its property NotesPosition takes the value NotesPositions.BottomFull. |
joinPortionsWithSameFormatting
| Name | Description |
|---|---|
| joinPortionsWithSameFormatting () | Joins runs with same formatting in all paragraphs in all acceptable shapes. |
Returns: void
remove
| Name | Description |
|---|---|
| remove () | Removes slide from presentation. |
Returns: void
Exception
| Error | Condition |
|---|---|
| PptxEditException | Thrown if slide is already removed from presentation. |
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. |
Returns: void
Exception
| 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. |
Returns: void
Exception
| 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. |
Returns: void
Exception
| 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. |
Returns: void
setHidden
| Name | Description |
|---|---|
| setHidden (boolean) | Determines whether the specified slide is hidden during a slide show. Read/write boolean. |
Returns: void
setLayoutSlide
| Name | Description |
|---|---|
| setLayoutSlide (LayoutSlide) | Returns or sets the layout slide for the current slide. Read/write ILayoutSlide. |
Returns: void
setShowMasterShapes
| Name | Description |
|---|---|
| setShowMasterShapes (boolean) | Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean. |
Returns: void
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. |
Returns: void
writeAsSvg
| Name | Description |
|---|---|
| writeAsSvg (OutputStream) | Saves content of slide as SVG file. |
Parameters:
| Name | Type | Description |
|---|---|---|
| stream | OutputStream | Target stream |
Returns: void
writeAsSvg
| Name | Description |
|---|---|
| writeAsSvg (OutputStream, SVGOptions) | Saves content of slide as SVG file. |
Parameters:
| Name | Type | Description |
|---|---|---|
| stream | OutputStream | Target stream |
| svgOptions | SVGOptions | SVG generation options |
Returns: void