com.aspose.slides

Constructor Detail

• Presentation

  public Presentation()

  This constructor creates new presentation from scratch. Created presentation has one empty slide.

• Presentation

  public Presentation(LoadOptions loadOptions)

  This constructor creates new presentation from scratch. Created presentation has one empty slide.

  Parameters:

  loadOptions - Additional load options.

• Presentation

  public Presentation(java.io.InputStream stream)

  This constructor is the primary mechanism for reading an existing Presentation.

  ---

   
   
   FileInputStream fis = new FileInputStream("demo.pptx");
   Presentation pres = new Presentation(fis);
   fis.close();
   
   

  Parameters:

  stream - Input stream.

• Presentation

  public Presentation(java.io.InputStream stream,
                      LoadOptions loadOptions)

  This constructor is the primary mechanism for reading an existing Presentation.

  Parameters:

  stream - Input stream.

  loadOptions - Additional load options.

• Presentation

  public Presentation(java.lang.String file)

  This constructor gets a source file path from which the contents of the Presentation are read.

  ---

   
   
   Presentation pres = new Presentation("demo.pptx");
   
   

  Parameters:

  file - Input file.

  Throws:

  com.aspose.ms.System.ArgumentException - Thrown when input file has zero length

• Presentation

  public Presentation(java.lang.String file,
                      LoadOptions loadOptions)

  This constructor gets a source file path from which the contents of the Presentation are read.

  Parameters:

  file - Input file.

  loadOptions - Additional load options.

  Throws:

  com.aspose.ms.System.ArgumentException - Thrown when input file has zero length

Method Detail

• getCurrentDateTime

  public final java.util.Date getCurrentDateTime()

  Returns or sets date and time which will substitute content of datetime fields. Time of this Presentation object creation by default. Read/write Date.

  Specified by:

  getCurrentDateTime in interface IPresentation

• setCurrentDateTime

  public final void setCurrentDateTime(java.util.Date value)

  Returns or sets date and time which will substitute content of datetime fields. Time of this Presentation object creation by default. Read/write Date.

  Specified by:

  setCurrentDateTime in interface IPresentation

• getParent_Immediate

  public final com.aspose.slides.IDOMObject getParent_Immediate()

  Returns Parent_Immediate object. Read-only IDOMObject.

• getHeaderFooterManager

  public final IPresentationHeaderFooterManager getHeaderFooterManager()

  Returns actual HeaderFooter manager. Read-only IPresentationHeaderFooterManager.

  Specified by:

  getHeaderFooterManager in interface IPresentation

• getProtectionManager

  public final IProtectionManager getProtectionManager()

  Gets manager of the permissions for this presentation. Read-only IProtectionManager.

  Specified by:

  getProtectionManager in interface IPresentation

• getSlides

  public final ISlideCollection getSlides()

  Returns a list of all slides that are defined in the presentation. Read-only ISlideCollection.

  Specified by:

  getSlides in interface IPresentation

• getSections

  public final ISectionCollection getSections()

  Returns a list of all slides sections that are defined in the presentation. Read-only ISectionCollection.

  Specified by:

  getSections in interface IPresentation

• getSlideSize

  public final ISlideSize getSlideSize()

  Returns slide size object. Read-only ISlideSize.

  Specified by:

  getSlideSize in interface IPresentation

• getNotesSize

  public final INotesSize getNotesSize()

  Returns notes slide size object. Read-only INotesSize.

  Specified by:

  getNotesSize in interface IPresentation

• getLayoutSlides

  public final IGlobalLayoutSlideCollection getLayoutSlides()

  Returns a list of all layout slides that are defined in the presentation. Read-only IGlobalLayoutSlideCollection.

  ---

  You can access to alternative API for adding/inserting/removing/cloning layout slides by using IMasterSlide.LayoutSlides property.

  Specified by:

  getLayoutSlides in interface IPresentation

• getMasters

  public final IMasterSlideCollection getMasters()

  Returns a list of all master slides that are defined in the presentation. Read-only IMasterSlideCollection.

  Specified by:

  getMasters in interface IPresentation

• getMasterNotesSlideManager

  public final IMasterNotesSlideManager getMasterNotesSlideManager()

  Returns notes master manager. Read-only IMasterNotesSlideManager.

  Specified by:

  getMasterNotesSlideManager in interface IPresentation

• getMasterHandoutSlideManager

  public final IMasterHandoutSlideManager getMasterHandoutSlideManager()

  Returns handout master manager. Read-only IMasterHandoutSlideManager.

  Specified by:

  getMasterHandoutSlideManager in interface IPresentation

• getFontsManager

  public final IFontsManager getFontsManager()

  Returns fonts manager. Read-only IFontsManager.

  Specified by:

  getFontsManager in interface IPresentation

• getDefaultTextStyle

  public final ITextStyle getDefaultTextStyle()

  Returns default text style for shapes. Read-only ITextStyle.

  Specified by:

  getDefaultTextStyle in interface IPresentation

• getCommentAuthors

  public final ICommentAuthorCollection getCommentAuthors()

  Returns the collection of comments autors. Read-only ICommentAuthorCollection.

  Specified by:

  getCommentAuthors in interface IPresentation

• getDocumentProperties

  public final IDocumentProperties getDocumentProperties()

  Returns DocumentProperties object which contains standard and custom document properties. Read-only IDocumentProperties.

  Specified by:

  getDocumentProperties in interface IPresentation

• getImages

  public final IImageCollection getImages()

  Returns the collection of all images in the presentation. Read-only IImageCollection.

  Specified by:

  getImages in interface IPresentation

• getAudios

  public final IAudioCollection getAudios()

  Returns the collection of all embedded audio files in the presentation. Read-only IAudioCollection.

  Specified by:

  getAudios in interface IPresentation

• getVideos

  public final IVideoCollection getVideos()

  Returns the collection of all embedded video files in the presentation. Read-only IVideoCollection.

  Specified by:

  getVideos in interface IPresentation

• getCustomData

  public final ICustomData getCustomData()

  Returns the presentation's custom data. Read-only ICustomData.

  Specified by:

  getCustomData in interface IPresentation

• getAllCustomXmlParts

  public final ICustomXmlPart[] getAllCustomXmlParts()

  Returns all custom data parts in the presentaion. Read-only ICustomXmlPart[].

  Specified by:

  getAllCustomXmlParts in interface IPresentation

• getVbaProject

  public final IVbaProject getVbaProject()

  Gets or sets VBA project with presentation macros. Read/write IVbaProject.

  Specified by:

  getVbaProject in interface IPresentation

• setVbaProject

  public final void setVbaProject(IVbaProject value)

  Gets or sets VBA project with presentation macros. Read/write IVbaProject.

  Specified by:

  setVbaProject in interface IPresentation

• getHyperlinkQueries

  public final IHyperlinkQueries getHyperlinkQueries()

  Provides easy access to all hyperlinks contained in all presentation slides (not in master, layout, notes slides). Read-only IHyperlinkQueries.

  Specified by:

  getHyperlinkQueries in interface IPresentation

• getViewProperties

  public final IViewProperties getViewProperties()

  Gets presentation wide view properties. Read-only IViewProperties.

  Specified by:

  getViewProperties in interface IPresentation

• getFirstSlideNumber

  public final int getFirstSlideNumber()

  Represents the first slide number in the presentation

  Specified by:

  getFirstSlideNumber in interface IPresentation

• setFirstSlideNumber

  public final void setFirstSlideNumber(int value)

  Represents the first slide number in the presentation

  Specified by:

  setFirstSlideNumber in interface IPresentation

• getSlideById

  public final IBaseSlide getSlideById(long id)

  Returns a Slide, MasterSlide or LayoutSlide by Id.

  Specified by:

  getSlideById in interface IPresentation

  Parameters:

  id - Id of a slide.

  Returns:

  IBaseSlide object.

• getSourceFormat

  public final int getSourceFormat()

  Returns information about from which format presentation was loaded. Read-only SourceFormat.

  Specified by:

  getSourceFormat in interface IPresentation

• getMasterTheme

  public final IMasterTheme getMasterTheme()

  Returns master theme. Read-only IMasterTheme.

  Specified by:

  getMasterTheme in interface IPresentation

• save

  public final void save(java.lang.String fname,
                         int format)

  Saves all slides of a presentation to a file with the specified format.

  Specified by:

  save in interface IPresentation

  Parameters:

  fname - Path to the created file.

  format - Format of the exported data.

• save

  public final void save(java.io.OutputStream stream,
                         int format)

  Saves all slides of a presentation to a stream in the specified format.

  Specified by:

  save in interface IPresentation

  Parameters:

  stream - Output stream.

  format - Format of the exported data.

• save

  public final void save(java.lang.String fname,
                         int format,
                         ISaveOptions options)

  Saves all slides of a presentation to a file with the specified format and with additional options.

  Specified by:

  save in interface IPresentation

  Parameters:

  fname - Path to the created file.

  format - Format of the exported data.

  options - Additional format options.

• save

  public final void save(java.io.OutputStream stream,
                         int format,
                         ISaveOptions options)

  Saves all slides of a presentation to a stream in the specified format and with additional options.

  Specified by:

  save in interface IPresentation

  Parameters:

  stream - Output stream.

  format - Format of the exported data.

  options - Additional format options.

  Throws:

  com.aspose.ms.System.NotSupportedException - If you try to save encrypted file in none Office 2007-2010 format

• getThumbnails

  public final android.graphics.Bitmap[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting)

  Returns a Thumbnail android.graphics.Bitmap objects for all slides of a presentation.

  Specified by:

  getThumbnails in interface IPresentation

  Parameters:

  notesCommentsLayouting - Options for notes and comments layouting.

  Returns:

  android.graphics.Bitmap objects.

• getThumbnails

  public final android.graphics.Bitmap[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                       int[] slides)

  Returns a Thumbnail android.graphics.Bitmap objects for specified slides of a presentation.

  Specified by:

  getThumbnails in interface IPresentation

  Parameters:

  notesCommentsLayouting - Options for notes and comments layouting.

  slides - Array with slide positions, starting from 1.

  Returns:

  android.graphics.Bitmap objects.

• getThumbnails

  public final android.graphics.Bitmap[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                       float scaleX,
                                                       float scaleY)

  Returns a Thumbnail android.graphics.Bitmap objects for all slides of a presentation with custom scaling.

  Specified by:

  getThumbnails in interface IPresentation

  Parameters:

  notesCommentsLayouting - Options for notes and comments layouting.

  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:

  android.graphics.Bitmap objects.

• getThumbnails

  public final android.graphics.Bitmap[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                       int[] slides,
                                                       float scaleX,
                                                       float scaleY)

  Returns a Thumbnail android.graphics.Bitmap objects for specified slides of a presentation with custom scaling.

  Specified by:

  getThumbnails in interface IPresentation

  Parameters:

  notesCommentsLayouting - Options for notes and comments layouting.

  slides - Array with slide positions, starting from 1.

  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:

  android.graphics.Bitmap objects.

• getThumbnails

  public final android.graphics.Bitmap[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                       Size imageSize)

  Returns a Thumbnail android.graphics.Bitmap objects for all slides of a presentation with specified size.

  Specified by:

  getThumbnails in interface IPresentation

  Parameters:

  notesCommentsLayouting - Options for notes and comments layouting.

  imageSize - Size of the image to create.

  Returns:

  android.graphics.Bitmap objects.

• getThumbnails

  public final android.graphics.Bitmap[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
                                                       int[] slides,
                                                       Size imageSize)

  Returns a Thumbnail android.graphics.Bitmap objects for specified slides of a presentation with specified size.

  Specified by:

  getThumbnails in interface IPresentation

  Parameters:

  notesCommentsLayouting - Options for notes and comments layouting.

  slides - Array with slide positions, starting from 1.

  imageSize - Size of the image to create.

  Returns:

  android.graphics.Bitmap objects.

• save

  public final void save(java.lang.String fname,
                         int[] slides,
                         int format)

  Saves specified slides of a presentation to a file with the specified format with page number keeping.

  Specified by:

  save in interface IPresentation

  Parameters:

  fname - Path to the created file.

  slides - Array with slide positions, starting from 1.

  format - Format of the exported data.

  Throws:

  com.aspose.ms.System.ArgumentNullException - When stream or slides parameter is null.

  com.aspose.ms.System.ArgumentOutOfRangeException - When slides parameter contains wrong page numbers.

  com.aspose.ms.System.InvalidOperationException - When an unsupported SaveFormat is used, e.g. PPTX, PPTM, PPSX, PPSM, POTX, POTM, PPT, ODP.

• save

  public final void save(java.lang.String fname,
                         int[] slides,
                         int format,
                         ISaveOptions options)

  Saves specified slides of a presentation to a file with the specified format with page number keeping.

  Specified by:

  save in interface IPresentation

  Parameters:

  fname - Path to the created file.

  slides - Array with slide positions, starting from 1.

  format - Format of the exported data.

  options - Additional format options.

• save

  public final void save(java.io.OutputStream stream,
                         int[] slides,
                         int format)

  Saves specified slides of a presentation to a stream in the specified format with page number keeping.

  Specified by:

  save in interface IPresentation

  Parameters:

  stream - Output stream.

  slides - Array with slide positions, starting from 1.

  format - Format of the exported data.

• save

  public final void save(java.io.OutputStream stream,
                         int[] slides,
                         int format,
                         ISaveOptions options)

  Saves specified slides of a presentation to a stream in the specified format with page number keeping.

  Specified by:

  save in interface IPresentation

  Parameters:

  stream - Output stream.

  slides - Array with slide positions, starting from 1.

  format - Format of the exported data.

  options - Additional format options.

  Throws:

  com.aspose.ms.System.ArgumentNullException - When stream or slides parameter is null.

  com.aspose.ms.System.ArgumentOutOfRangeException - When slides parameter contains wrong page numbers.

  com.aspose.ms.System.InvalidOperationException - When an unsupported SaveFormat is used, e.g. PPTX, PPTM, PPSX, PPSM, POTX, POTM, PPT, ODP.

• joinPortionsWithSameFormatting

  public final void joinPortionsWithSameFormatting()

  Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides.

  Specified by:

  joinPortionsWithSameFormatting in interface IPresentation

• dispose

  public final void dispose()

  Releases all resources used by this Aspose.Slides.Pptx.PrentationEx object.

  Specified by:

  dispose in interface com.aspose.ms.System.IDisposable

• getPresentation

  public final IPresentation getPresentation()

  Returns the parent presentation of a text. Read-only IPresentation.

  Specified by:

  getPresentation in interface IPresentationComponent