ISlide
All Implemented Interfaces: com.aspose.slides.IBaseSlide, com.aspose.slides.IOverrideThemeable
public interface ISlide extends IBaseSlide, IOverrideThemeable
Represents a slide in a presentation.
Methods
| Method | Description |
|---|---|
| getHeaderFooterManager() | Returns HeaderFooter manager of the slide. |
| getSlideNumber() | Returns a number of slide. |
| setSlideNumber(int value) | Returns a number of slide. |
| getHidden() | Determines whether the specified slide is hidden during a slide show. |
| setHidden(boolean value) | Determines whether the specified slide is hidden during a slide show. |
| getThumbnail(float scaleX, float scaleY) | Returns a Thumbnail Bitmap object with custom scaling. |
| getThumbnail() | Returns a Thumbnail Image object (20% of real size). |
| getThumbnail(Dimension imageSize) | Returns a Thumbnail Bitmap object with specified size. |
| getThumbnail(ITiffOptions options) | Returns a Thumbnail tiff bitmap object with specified parameters. |
| getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting) | Returns a Thumbnail BufferedImage object. |
| getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY) | Returns a Thumbnail BufferedImage object with custom scaling. |
| getThumbnail(INotesCommentsLayoutingOptions options, Dimension imageSize) | Returns a Thumbnail BufferedImage object with specified size. |
| getThumbnail(IRenderingOptions options) | Returns a Thumbnail BufferedImage object. |
| getThumbnail(IRenderingOptions options, float scaleX, float scaleY) | Returns a Thumbnail BufferedImage object with custom scaling. |
| getThumbnail(IRenderingOptions options, Dimension imageSize) | Returns a Thumbnail BufferedImage object with specified size. |
| renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, int width, int height) | Renders certain slide to a Graphics object. |
| renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, float scale) | Renders certain slide to a Graphics object. |
| renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics) | Renders certain slide to a Graphics object. |
| renderToGraphics(IRenderingOptions options, Graphics2D graphics) | Renders certain slide to a Graphics object. |
| renderToGraphics(IRenderingOptions options, Graphics2D graphics, float scaleX, float scaleY) | Renders certain slide to a Graphics object with custom scaling. |
| renderToGraphics(IRenderingOptions options, Graphics2D graphics, Dimension renderingSize) | Renders certain slide to a Graphics object using specified size. |
| getLayoutSlide() | Returns or sets the layout slide for the current slide. |
| setLayoutSlide(ILayoutSlide value) | Returns or sets the layout slide for the current slide. |
| getNotesSlideManager() | Allow to access notes slide, add and remove it. |
| getSlideComments(ICommentAuthor author) | Returns all slide comments added by specific author. |
| writeAsSvg(OutputStream stream) | Saves content of slide as SVG file. |
| writeAsSvg(OutputStream stream, ISVGOptions svgOptions) | Saves content of slide as SVG file. |
| remove() | Removes slide from presentation. |
| reset() | Resets position, size and formatting of every shape that has a prototype on LayoutSlide. |
getHeaderFooterManager()
public abstract ISlideHeaderFooterManager getHeaderFooterManager()
Returns HeaderFooter manager of the slide. Read-only ISlideHeaderFooterManager.
Returns: ISlideHeaderFooterManager
getSlideNumber()
public abstract int getSlideNumber()
Returns a number of slide. Index of slide in (IPresentation.getSlides) collection is always equal to SlideNumber - 1. Read/write int.
Returns: int
setSlideNumber(int value)
public abstract void setSlideNumber(int value)
Returns a number of slide. Index of slide in (IPresentation.getSlides) collection is always equal to SlideNumber - 1. Read/write int.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
getHidden()
public abstract boolean getHidden()
Determines whether the specified slide is hidden during a slide show. Read/write boolean.
Returns: boolean
setHidden(boolean value)
public abstract void setHidden(boolean value)
Determines whether the specified slide is hidden during a slide show. Read/write boolean.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getThumbnail(float scaleX, float scaleY)
public abstract BufferedImage getThumbnail(float scaleX, float scaleY)
Returns a Thumbnail Bitmap object with custom scaling.
Parameters:
| Parameter | 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: java.awt.image.BufferedImage - Bitmap object java.awt.image.BufferedImage
getThumbnail()
public abstract BufferedImage getThumbnail()
Returns a Thumbnail Image object (20% of real size).
Returns: java.awt.image.BufferedImage - Bitmap object java.awt.image.BufferedImage
getThumbnail(Dimension imageSize)
public abstract BufferedImage getThumbnail(Dimension imageSize)
Returns a Thumbnail Bitmap object with specified size.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageSize | java.awt.Dimension | Size of the image to create. |
Returns: java.awt.image.BufferedImage - Bitmap object.
getThumbnail(ITiffOptions options)
public abstract BufferedImage getThumbnail(ITiffOptions options)
Returns a Thumbnail tiff bitmap object with specified parameters.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ITiffOptions | Tiff options. |
Returns: java.awt.image.BufferedImage - Bitmap object.
getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting)
public abstract BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting)
Returns a Thumbnail BufferedImage object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| notesCommentsLayouting | INotesCommentsLayoutingOptions | Options for notes and comments layouting. |
Returns: java.awt.image.BufferedImage - BufferedImage objects.
getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY)
public abstract BufferedImage getThumbnail(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY)
Returns a Thumbnail BufferedImage object with custom scaling.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| notesCommentsLayouting | INotesCommentsLayoutingOptions | 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. |
Returns: java.awt.image.BufferedImage - BufferedImage objects.
getThumbnail(INotesCommentsLayoutingOptions options, Dimension imageSize)
public abstract BufferedImage getThumbnail(INotesCommentsLayoutingOptions options, Dimension imageSize)
Returns a Thumbnail BufferedImage object with specified size.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | INotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| imageSize | java.awt.Dimension | Size of the image to create. |
Returns: java.awt.image.BufferedImage - BufferedImage objects.
getThumbnail(IRenderingOptions options)
public abstract BufferedImage getThumbnail(IRenderingOptions options)
Returns a Thumbnail BufferedImage object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | IRenderingOptions | Rendering options. |
Returns: java.awt.image.BufferedImage - BufferedImage objects.
getThumbnail(IRenderingOptions options, float scaleX, float scaleY)
public abstract BufferedImage getThumbnail(IRenderingOptions options, float scaleX, float scaleY)
Returns a Thumbnail BufferedImage object with custom scaling.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | IRenderingOptions | 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: java.awt.image.BufferedImage - BufferedImage objects.
getThumbnail(IRenderingOptions options, Dimension imageSize)
public abstract BufferedImage getThumbnail(IRenderingOptions options, Dimension imageSize)
Returns a Thumbnail BufferedImage object with specified size.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | IRenderingOptions | Rendering options. |
| imageSize | java.awt.Dimension | Size of the image to create. |
Returns: java.awt.image.BufferedImage - BufferedImage objects.
renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, int width, int height)
public abstract void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, int width, int height)
Renders certain slide to a Graphics object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| notesCommentsLayouting | INotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| graphics | java.awt.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. |
renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, float scale)
public abstract void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics, float scale)
Renders certain slide to a Graphics object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| notesCommentsLayouting | INotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| graphics | java.awt.Graphics2D | The object where to render to. |
| scale | float | The scale for rendering the slide (1.0 is 100%). |
renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics)
public abstract void renderToGraphics(INotesCommentsLayoutingOptions notesCommentsLayouting, Graphics2D graphics)
Renders certain slide to a Graphics object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| notesCommentsLayouting | INotesCommentsLayoutingOptions | Options for notes and comments layouting. |
| graphics | java.awt.Graphics2D | The object where to render to. |
renderToGraphics(IRenderingOptions options, Graphics2D graphics)
public abstract void renderToGraphics(IRenderingOptions options, Graphics2D graphics)
Renders certain slide to a Graphics object.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | IRenderingOptions | Rendering options. |
| graphics | java.awt.Graphics2D | The object where to render to. |
renderToGraphics(IRenderingOptions options, Graphics2D graphics, float scaleX, float scaleY)
public abstract void renderToGraphics(IRenderingOptions options, Graphics2D graphics, float scaleX, float scaleY)
Renders certain slide to a Graphics object with custom scaling.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | IRenderingOptions | Rendering options. |
| graphics | java.awt.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. |
renderToGraphics(IRenderingOptions options, Graphics2D graphics, Dimension renderingSize)
public abstract void renderToGraphics(IRenderingOptions options, Graphics2D graphics, Dimension renderingSize)
Renders certain slide to a Graphics object using specified size.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | IRenderingOptions | Rendering options. |
| graphics | java.awt.Graphics2D | The object where to render to. |
| renderingSize | java.awt.Dimension | The maximum dimensions (in pixels) that can be occupied by the rendered slide. |
getLayoutSlide()
public abstract ILayoutSlide getLayoutSlide()
Returns or sets the layout slide for the current slide. Read/write ILayoutSlide.
Returns: ILayoutSlide
setLayoutSlide(ILayoutSlide value)
public abstract void setLayoutSlide(ILayoutSlide value)
Returns or sets the layout slide for the current slide. Read/write ILayoutSlide.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ILayoutSlide |
getNotesSlideManager()
public abstract INotesSlideManager getNotesSlideManager()
Allow to access notes slide, add and remove it. Read-only INotesSlideManager.
Returns: INotesSlideManager
getSlideComments(ICommentAuthor author)
public abstract IComment[] getSlideComments(ICommentAuthor author)
Returns all slide comments added by specific author.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| author | ICommentAuthor | Author of comments to find or null to return all comments. |
Returns: com.aspose.slides.IComment[] - Array of IComment.
writeAsSvg(OutputStream stream)
public abstract void writeAsSvg(OutputStream stream)
Saves content of slide as SVG file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | java.io.OutputStream | Target stream |
writeAsSvg(OutputStream stream, ISVGOptions svgOptions)
public abstract void writeAsSvg(OutputStream stream, ISVGOptions svgOptions)
Saves content of slide as SVG file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| stream | java.io.OutputStream | Target stream |
| svgOptions | ISVGOptions | SVG generation options |
remove()
public abstract void remove()
Removes slide from presentation.
reset()
public abstract void reset()
Resets position, size and formatting of every shape that has a prototype on LayoutSlide.