com.aspose.slides
Class Presentation

java.lang.Object
  extended by com.aspose.slides.Presentation

public final class Presentation
extends java.lang.Object

Represents the Microsoft PowerPoint presentation.


Field Summary
static java.lang.String resources_path
           
 
Constructor Summary
Presentation()
          This constructor creates new presentation from scratch.
Presentation(java.io.InputStream stream)
          This constructor is the primary mechanism for reading an existing Presentation.
Presentation(java.lang.String file)
          This constructor gets a source file path from which the contents of the Presentation are read.
 
Method Summary
 Slide addBodySlide()
          Adds the new Slide with header and body placeholders to a presentation.
 Slide addDoubleBodySlide()
          Adds the new Slide with header and two body placeholders to a presentation.
 Slide addEmptySlide()
          Adds the new empty Slide to a presentation.
 Slide addHeaderSlide()
          Adds the new Slide with header placeholder to a presentation.
 Slide addTitleSlide()
          Adds the new Slide with header and subheader placeholders to a presentation.
 void cleanAnimations()
          Removes XP+ animations from slides.
 Slide cloneSlide(Slide srcSlide, int position)
          Makes the copy of a slide.
 Slide cloneSlide(Slide srcSlide, int position, Presentation pres, java.util.TreeMap idList)
          Makes a copy of a slide with master slides and inserts it to another presentation.
 void deleteHandout()
          Deletes Handout object from a presentation.
 void deleteUnusedMasters()
          Deletes all unused masters from a presentation.
 long getActiveSlideId()
          Returns the Id of the active slide in a presentation.
 CommentAuthors getCommentAuthors()
          Returns the list of authors of comments in a presentation.
 DocumentProperties getDocumentProperties()
          Returns the custom properties of a presentation.
 short getFirstSlideNumber()
          Returns the number of the first slide in a presentation.
 Fonts getFonts()
          Returns the list of all fonts in a presentation.
 LoadOptions getLoadOptions()
           
 MainMaster getMainMaster()
          Returns the first main master of a presentation.
 Slides getMasters()
          Returns the list of all masters in a presentation.
 java.awt.Point getNotesSize()
          Returns the size of a notes in a presentation.
 PictureBullets getPictureBullets()
          Returns a list of all pictures used for a bullets that are defined in the presentation.
 Pictures getPictures()
          Returns the list of all pictures in a presentation.
 Slide getSlideById(long id)
          Returns the slide by Id.
 Slide getSlideByPosition(int position)
          Returns the slide by SlidePosition.
 Slides getSlides()
          Returns the list of all slides in a presentation.
 SlideShowSettings getSlideShowSettings()
          Returns the settings of a slide show in a presentation.
 java.awt.Point getSlideSize()
          Returns the size of a slides in a presentation.
 int getSlideSizeType()
          Returns the size type of a slides in a presentation.
 int getSlideViewType()
          Returns the way how the presentation will be opened.
 Tags getTags()
          Returns the tags of a presentation.
 boolean hasVBAMacros()
          Determines whether a presentation contains any VBA macros.
 void removeVBAMacros()
          Removes all VBA macros from the presentation.
 void save(java.io.OutputStream stream, SaveFormat format)
          Saves all slides of a presentation to a stream in the specified format.
 void save(java.io.OutputStream stream, SaveFormat format, SaveOptions options)
          Saves all slides of a presentation to a stream in the specified format and with additional options.
 void save(java.lang.String fname, SaveFormat format)
          Saves all slides of a presentation to a file with the specified format.
 void save(java.lang.String fname, SaveFormat format, SaveOptions options)
          Saves all slides of a presentation to a file with the specified format and with additional options.
 void setActiveSlideId(long value)
          Sets the Id of the active slide in a presentation.
 void setFirstSlideNumber(short value)
          Sets the number of the first slide in a presentation.
 void setSlideSize(java.awt.Point value)
          Sets the size of a slides in a presentation.
 void setSlideSizeType(int value)
          Sets the SizeType of a slides in a presentation.
 void setSlideViewType(int value)
          Sets the way how the presentation will be opened.
 void write(java.io.OutputStream stream)
          Writes the contents of the Presentation to an output stream.
 void write(java.lang.String file)
          Writes the contents of the Presentation to a file specified by the file name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

resources_path

public static java.lang.String resources_path
Constructor Detail

Presentation

public Presentation()
             throws PptReadException
This constructor creates new presentation from scratch. Created presentation has one empty slide.

Throws:
PptReadException

Presentation

public Presentation(java.io.InputStream stream)
             throws PptException
This constructor is the primary mechanism for reading an existing Presentation.

Parameters:
stream - the input stream.
Throws:
PptException - on presentation reading errors.

Presentation

public Presentation(java.lang.String file)
             throws PptException,
                    java.io.FileNotFoundException
This constructor gets a source file path from which the contents of the Presentation are read.

Parameters:
file - input file name
Throws:
PptException
java.io.FileNotFoundException
Method Detail

write

public void write(java.lang.String file)
Writes the contents of the Presentation to a file specified by the file name.

Parameters:
file - Output file.

write

public void write(java.io.OutputStream stream)
           throws PptWriteException
Writes the contents of the Presentation to an output stream.

Parameters:
stream - the output stream.
Throws:
PptWriteException - on presentation writing errors.

cleanAnimations

public void cleanAnimations()
Removes XP+ animations from slides.


deleteHandout

public void deleteHandout()
Deletes Handout object from a presentation.


deleteUnusedMasters

public void deleteUnusedMasters()
Deletes all unused masters from a presentation.


getSlides

public Slides getSlides()
Returns the list of all slides in a presentation.

Returns:
The slides list.

getMasters

public Slides getMasters()
Returns the list of all masters in a presentation.

Returns:
The masters list.

getMainMaster

public MainMaster getMainMaster()
Returns the first main master of a presentation.

Returns:
The first main master.

getSlideById

public Slide getSlideById(long id)
Returns the slide by Id.

Parameters:
id - the Id of a slide.
Returns:
The slide object.

getSlideByPosition

public Slide getSlideByPosition(int position)
Returns the slide by SlidePosition.

Parameters:
position - the position of a slide.
Returns:
The slide object.

cloneSlide

public Slide cloneSlide(Slide srcSlide,
                        int position)
                 throws PptEditException
Makes the copy of a slide.

Parameters:
srcSlide - the source slide to clone.
position - the position where new slide should be inserted.
Returns:
The new slide object.
Throws:
PptEditException - on slide cloning errors.

cloneSlide

public Slide cloneSlide(Slide srcSlide,
                        int position,
                        Presentation pres,
                        java.util.TreeMap idList)
                 throws PptEditException
Makes a copy of a slide with master slides and inserts it to another presentation.

Parameters:
srcSlide - the source slide.
position - the position where new slide should be inserted.
pres - the presentation where new slide will be inserted.
idList - TreeMap object to store temporary information about ppt's masters.
Returns:
The new slide object.
Throws:
PptEditException - on slide cloning errors.

addEmptySlide

public Slide addEmptySlide()
                    throws PptReadException,
                           PptEditException
Adds the new empty Slide to a presentation.

Returns:
Slide object.
Throws:
PptReadException
PptEditException

addBodySlide

public Slide addBodySlide()
                   throws PptReadException,
                          PptEditException
Adds the new Slide with header and body placeholders to a presentation.

Returns:
Slide object.
Throws:
PptReadException
PptEditException

addDoubleBodySlide

public Slide addDoubleBodySlide()
                         throws PptReadException,
                                PptEditException
Adds the new Slide with header and two body placeholders to a presentation.

Returns:
Slide object.
Throws:
PptReadException
PptEditException

addTitleSlide

public Slide addTitleSlide()
                    throws PptReadException,
                           PptEditException
Adds the new Slide with header and subheader placeholders to a presentation.

Returns:
Slide object.
Throws:
PptReadException
PptEditException

addHeaderSlide

public Slide addHeaderSlide()
                     throws PptReadException,
                            PptEditException
Adds the new Slide with header placeholder to a presentation.

Returns:
Slide object.
Throws:
PptReadException
PptEditException

getPictures

public Pictures getPictures()
Returns the list of all pictures in a presentation.

Returns:
The pictures list.

getFonts

public Fonts getFonts()
Returns the list of all fonts in a presentation.

Returns:
The fonts list.

getSlideSize

public java.awt.Point getSlideSize()
Returns the size of a slides in a presentation.

Returns:
The size of a slides.

setSlideSize

public void setSlideSize(java.awt.Point value)
Sets the size of a slides in a presentation.

Parameters:
value - The size of a slides.

getNotesSize

public java.awt.Point getNotesSize()
Returns the size of a notes in a presentation.

Returns:
The size of a notes.

getSlideSizeType

public int getSlideSizeType()
Returns the size type of a slides in a presentation.

Returns:
The size type of a slides. See SlideSizeType.

setSlideSizeType

public void setSlideSizeType(int value)
Sets the SizeType of a slides in a presentation.

Parameters:
value - The size type of a slides. See SlideSizeType.

getSlideViewType

public int getSlideViewType()
Returns the way how the presentation will be opened. See SlideViewType.


setSlideViewType

public void setSlideViewType(int value)
Sets the way how the presentation will be opened.

Parameters:
value - See SlideViewType.

getDocumentProperties

public DocumentProperties getDocumentProperties()
Returns the custom properties of a presentation.

Returns:
the custom properties.

getFirstSlideNumber

public short getFirstSlideNumber()
Returns the number of the first slide in a presentation.

Returns:
the number of the first slide in a presentation.

setFirstSlideNumber

public void setFirstSlideNumber(short value)
Sets the number of the first slide in a presentation.

Parameters:
value - the number of the first slide in a presentation.

getActiveSlideId

public long getActiveSlideId()
Returns the Id of the active slide in a presentation.

Returns:
the Id of the active slide.

setActiveSlideId

public void setActiveSlideId(long value)
                      throws java.lang.Exception
Sets the Id of the active slide in a presentation.

Parameters:
value - the Id of the active slide.
Throws:
PptPropertyException
java.lang.Exception

hasVBAMacros

public boolean hasVBAMacros()
Determines whether a presentation contains any VBA macros.

Returns:
true if a presentation contains any VBA macros.

getSlideShowSettings

public SlideShowSettings getSlideShowSettings()
Returns the settings of a slide show in a presentation.

Returns:
the settings of a slide show in a presentation.

getTags

public Tags getTags()
Returns the tags of a presentation.

Returns:
the tags of a presentation.

getCommentAuthors

public CommentAuthors getCommentAuthors()
Returns the list of authors of comments in a presentation.


getPictureBullets

public PictureBullets getPictureBullets()
Returns a list of all pictures used for a bullets that are defined in the presentation.

Returns:
PictureBullets object.

save

public void save(java.lang.String fname,
                 SaveFormat format)
Saves all slides of a presentation to a file with the specified format.

Parameters:
fname - Path to the created file.
format - Format of the exported data.

save

public void save(java.io.OutputStream stream,
                 SaveFormat format)
Saves all slides of a presentation to a stream in the specified format.

Parameters:
stream - Output stream.
format - Format of the exported data.

save

public void save(java.lang.String fname,
                 SaveFormat format,
                 SaveOptions options)
Saves all slides of a presentation to a file with the specified format and with additional options.

Parameters:
fname - Path to the created file.
format - Format of the exported data.
options - Additional format options.

save

public void save(java.io.OutputStream stream,
                 SaveFormat format,
                 SaveOptions options)
Saves all slides of a presentation to a stream in the specified format and with additional options.

Parameters:
stream - Output stream.
format - Format of the exported data.
options - Additional format options.

removeVBAMacros

public void removeVBAMacros()
Removes all VBA macros from the presentation.


getLoadOptions

public LoadOptions getLoadOptions()