com.aspose.slides
Interface ISlide

All Known Implementing Classes:
MainMaster, Slide

public interface ISlide

Represents standard slide's properties.


Method Summary
 Notes addNotes()
          Adds the empty notes to a slide.
 void changeMaster(Slide newMaster)
          Replaces the master slide for a slide and changes placeholder's style.
 void changeMaster(Slide newMaster, boolean changeStyle)
          Replaces the master slide for a slide and optionally changes placeholder's style.
 Shape findShape(java.lang.String altText)
          Search and return the shape with defined alternative text.
 Background getBackground()
          Returns the background of a slide.
 HeaderFooter getHeaderFooter()
          Returns the header and footer settings for a slide.
 int getLayout()
          Returns the slide layout.
 long getMasterId()
          Returns the Id of a master slide.
 java.lang.String getName()
          Returns the name of a slide.
 Notes getNotes()
          Returns the notes of a slide.
 Presentation getParent()
          Returns the parent presentation.
 Placeholders getPlaceholders()
          Returns the placeholders of a slide.
 Shapes getShapes()
          Returns the shapes of a slide.
 SlideComments getSlideComments()
          Returns the collection of slide comments.
 long getSlideId()
          Returns the Id of a slide.
 int getSlidePosition()
          Returns the position of a slide.
 SlideShowTransition getSlideShowTransition()
          Returns the SlideShowTransition object which contains information about how the specified slide advances during a slide show.
 Tags getTags()
          Returns the tags of a slide.
 java.awt.image.BufferedImage getThumbnail(java.util.Collection elementsToDraw, java.awt.Dimension imageSize, java.awt.geom.Rectangle2D.Float window)
          Returns a Thumbnail Image of specified elements with specified size.
 java.awt.image.BufferedImage getThumbnail(java.util.Collection elementsToDraw, float scaleX, float scaleY, java.awt.geom.Rectangle2D.Float window)
          Returns a Thumbnail Image of specified elements with specified size.
 java.awt.image.BufferedImage getThumbnail(java.awt.Dimension imageSize, java.awt.geom.Rectangle2D.Float window, IDrawingControl drawingControl)
          Returns the thumbnail image object with specified size.
 java.awt.image.BufferedImage getThumbnail(float scaleX, float scaleY)
          Returns the thumbnail image object with custom scaling.
 java.awt.image.BufferedImage getThumbnail(float scaleX, float scaleY, java.awt.geom.Rectangle2D.Float window, IDrawingControl drawingControl)
          Returns a Thumbnail Image object with custom scaling.
 boolean isFollowMasterBackground()
          Determines whether the slide follows the master slide background.
 boolean isFollowMasterObjects()
          Determines whether the slide objects follow the master slide objects style.
 boolean isFollowMasterScheme()
          Determines whether the slide follows the master slide color scheme.
 boolean isMasterSlide()
          Determines whether the slide is a master slide.
 void saveToSVG(java.io.OutputStream stream)
          Creates image of a slide in SVG (vector graphics) format and writes it to a stream.
 void setFollowMasterBackground(boolean value)
          Sets whether the slide follows the master slide background.
 void setFollowMasterObjects(boolean value)
          Sets whether the slide objects follow the master slide objects style.
 void setFollowMasterScheme(boolean value)
          Sets whether the slide follows the master slide color scheme.
 void setMasterId(long value)
          Sets the ID of a master slide.
 void setName(java.lang.String value)
          Sets the name of a slide.
 void setSlidePosition(int value)
          Sets the position of a slide.
 

Method Detail

addNotes

Notes addNotes()
               throws PptEditException
Adds the empty notes to a slide.

Throws:
PptEditException - on notes adding errors.

getNotes

Notes getNotes()
Returns the notes of a slide.

Returns:
The notes of a slide.

getParent

Presentation getParent()
Returns the parent presentation.

Returns:
The parent presentation.

getShapes

Shapes getShapes()
Returns the shapes of a slide.

Returns:
The shapes of a slide.

getPlaceholders

Placeholders getPlaceholders()
Returns the placeholders of a slide.

Returns:
The placeholders of a slide.

getBackground

Background getBackground()
Returns the background of a slide.

Returns:
The background of a slide.

getSlideId

long getSlideId()
Returns the Id of a slide.

Returns:
The slide Id.

getMasterId

long getMasterId()
Returns the Id of a master slide.

Returns:
The master slide Id.

setMasterId

void setMasterId(long value)
Sets the ID of a master slide.

Parameters:
value - the new Id of a master slide.

isMasterSlide

boolean isMasterSlide()
Determines whether the slide is a master slide.

Returns:
true if slide is a master slide.

getSlidePosition

int getSlidePosition()
Returns the position of a slide.

Returns:
The slide position.

setSlidePosition

void setSlidePosition(int value)
Sets the position of a slide. Do nothing for master slides.

Parameters:
value - new slide position.

getLayout

int getLayout()
Returns the slide layout.

Returns:
The slide layout. See SlideLayout.

isFollowMasterObjects

boolean isFollowMasterObjects()
Determines whether the slide objects follow the master slide objects style.

Returns:
true if slide objects follow the master slide objects style.

setFollowMasterObjects

void setFollowMasterObjects(boolean value)
Sets whether the slide objects follow the master slide objects style.

Parameters:
value - true to force slide objects follow the master slide objects style.

isFollowMasterScheme

boolean isFollowMasterScheme()
Determines whether the slide follows the master slide color scheme.

Returns:
true if slide follows the master slide color scheme.

setFollowMasterScheme

void setFollowMasterScheme(boolean value)
Sets whether the slide follows the master slide color scheme.

Parameters:
value - true to force slide follow the master slide color scheme.

isFollowMasterBackground

boolean isFollowMasterBackground()
Determines whether the slide follows the master slide background.

Returns:
true if slide follows the master slide background.

setFollowMasterBackground

void setFollowMasterBackground(boolean value)
Sets whether the slide follows the master slide background.

Parameters:
value - true to force slide follow the master slide background.

getName

java.lang.String getName()
Returns the name of a slide.

Returns:
the name of a slide.

setName

void setName(java.lang.String value)
Sets the name of a slide.

Parameters:
value - the name of a slide.

getThumbnail

java.awt.image.BufferedImage getThumbnail(float scaleX,
                                          float scaleY)
                                          throws PptException
Returns the thumbnail image object with custom scaling.

Parameters:
scaleX - The value by which to scale this Thumbnail in the x-axis direction.
scaleY - The value by which to scale this Thumbnail in the y-axis direction.
Returns:
the thumbnail image of a slide.
Throws:
PptException

getThumbnail

java.awt.image.BufferedImage getThumbnail(java.util.Collection elementsToDraw,
                                          java.awt.Dimension imageSize,
                                          java.awt.geom.Rectangle2D.Float window)
                                          throws PptException
Returns a Thumbnail Image of specified elements with specified size.

Parameters:
elementsToDraw - a list of elements to draw.
imageSize - size of a new Image.
window - a part of slide to draw.
Returns:
Thumbnail Image of specified elements with specified size.
Throws:
PptException

getThumbnail

java.awt.image.BufferedImage getThumbnail(java.util.Collection elementsToDraw,
                                          float scaleX,
                                          float scaleY,
                                          java.awt.geom.Rectangle2D.Float window)
                                          throws PptException
Returns a Thumbnail Image of specified elements with specified size.

Parameters:
elementsToDraw - a list of elements to draw.
scaleX - value by which to scale thumbnail in the x-axis direction.
scaleY - value by which to scale thumbnail in the y-axis direction.
window - a part of slide to draw.
Returns:
Thumbnail Image of specified elements with specified size.
Throws:
PptException

getThumbnail

java.awt.image.BufferedImage getThumbnail(float scaleX,
                                          float scaleY,
                                          java.awt.geom.Rectangle2D.Float window,
                                          IDrawingControl drawingControl)
                                          throws PptException
Returns a Thumbnail Image object with custom scaling.

Parameters:
scaleX - value by which to scale thumbnail in the x-axis direction.
scaleY - value by which to scale thumbnail in the y-axis direction.
window - a part of slide to draw.
drawingControl - an object which determines which slide elements to draw or null to draw all.
Returns:
Thumbnail image with custom scaling.
Throws:
PptException

getThumbnail

java.awt.image.BufferedImage getThumbnail(java.awt.Dimension imageSize,
                                          java.awt.geom.Rectangle2D.Float window,
                                          IDrawingControl drawingControl)
                                          throws PptException
Returns the thumbnail image object with specified size.

Parameters:
imageSize - size of a new Image.
window - a part of slide to draw.
drawingControl - an object which determines which slide elements to draw or null to draw all.
Returns:
Thumbnail image object with specified size.
Throws:
PptException

saveToSVG

void saveToSVG(java.io.OutputStream stream)
               throws PptException,
                      AsposeLicenseException
Creates image of a slide in SVG (vector graphics) format and writes it to a stream.

Parameters:
stream - output stream.
Throws:
PptException
AsposeLicenseException

getSlideShowTransition

SlideShowTransition getSlideShowTransition()
Returns the SlideShowTransition object which contains information about how the specified slide advances during a slide show.

Returns:
The SlideShowTransition object.

changeMaster

void changeMaster(Slide newMaster)
                  throws PptEditException
Replaces the master slide for a slide and changes placeholder's style.

Parameters:
newMaster - New master slide.
Throws:
PptEditException

changeMaster

void changeMaster(Slide newMaster,
                  boolean changeStyle)
                  throws PptEditException
Replaces the master slide for a slide and optionally changes placeholder's style.

Parameters:
newMaster - New master slide.
changeStyle - true to change style of placeholders.
Throws:
PptEditException

getHeaderFooter

HeaderFooter getHeaderFooter()
Returns the header and footer settings for a slide.

Returns:
the header and footer settings. See HeaderFooter.

getTags

Tags getTags()
Returns the tags of a slide.

Returns:
The tags of a slide. See Tags.

findShape

Shape findShape(java.lang.String altText)
Search and return the shape with defined alternative text.

Parameters:
altText - Alternative text to find.
Returns:
Shape object.

getSlideComments

SlideComments getSlideComments()
Returns the collection of slide comments.

Returns:
collection of slide comments. See SlideComments.