public final class Presentation extends java.lang.Object implements IPresentation
Represents a Microsoft PowerPoint presentation.
| Constructor and Description |
|---|
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.io.InputStream stream,
LoadOptions loadOptions)
This constructor is the primary mechanism for reading an existing Presentation.
|
Presentation(LoadOptions loadOptions)
This constructor creates new presentation from scratch.
|
Presentation(java.lang.String file)
This constructor gets a source file path from which
the contents of the Presentation are read.
|
Presentation(java.lang.String file,
LoadOptions loadOptions)
This constructor gets a source file path from which
the contents of the Presentation are read.
|
| Modifier and Type | Method and Description |
|---|---|
void |
dispose()
Releases all resources used by this Presentation object.
|
ICustomXmlPart[] |
getAllCustomXmlParts()
Returns all custom data parts in the presentaion.
|
IAudioCollection |
getAudios()
Returns the collection of all embedded audio files in the presentation.
|
ICommentAuthorCollection |
getCommentAuthors()
Returns the collection of comments autors.
|
java.util.Date |
getCurrentDateTime()
Returns or sets date and time which will substitute content of datetime fields.
|
ICustomData |
getCustomData()
Returns the presentation's custom data.
|
ITextStyle |
getDefaultTextStyle()
Returns default text style for shapes.
|
IDigitalSignatureCollection |
getDigitalSignatures()
Returns the collection of signatures used to sign the presentation.
|
IDocumentProperties |
getDocumentProperties()
Returns DocumentProperties object which contains standard and custom document properties.
|
int |
getFirstSlideNumber()
Represents the first slide number in the presentation
|
IFontsManager |
getFontsManager()
Returns fonts manager.
|
IPresentationHeaderFooterManager |
getHeaderFooterManager()
Returns actual HeaderFooter manager.
|
IHyperlinkQueries |
getHyperlinkQueries()
Provides easy access to all hyperlinks contained in all presentation slides (not in master, layout, notes slides).
|
IImageCollection |
getImages()
Returns the collection of all images in the presentation.
|
IGlobalLayoutSlideCollection |
getLayoutSlides()
Returns a list of all layout slides that are defined in the presentation.
|
IMasterHandoutSlideManager |
getMasterHandoutSlideManager()
Returns handout master manager.
|
IMasterNotesSlideManager |
getMasterNotesSlideManager()
Returns notes master manager.
|
IMasterSlideCollection |
getMasters()
Returns a list of all master slides that are defined in the presentation.
|
IMasterTheme |
getMasterTheme()
Returns master theme.
|
INotesSize |
getNotesSize()
Returns notes slide size object.
|
com.aspose.slides.IDOMObject |
getParent_Immediate()
Returns Parent_Immediate object.
|
IPresentation |
getPresentation()
Returns the parent presentation of a text.
|
IProtectionManager |
getProtectionManager()
Gets manager of the permissions for this presentation.
|
ISectionCollection |
getSections()
Returns a list of all slides sections that are defined in the presentation.
|
IBaseSlide |
getSlideById(long id)
Returns a Slide, MasterSlide or LayoutSlide by Id.
|
ISlideCollection |
getSlides()
Returns a list of all slides that are defined in the presentation.
|
ISlideSize |
getSlideSize()
Returns slide size object.
|
int |
getSourceFormat()
Returns information about from which format presentation was loaded.
|
java.awt.image.BufferedImage[] |
getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting)
Deprecated.
Use Presentation.GetThumbnails(IRenderingOptions) instead. The method will be removed after release of version 21.4.
|
java.awt.image.BufferedImage[] |
getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
java.awt.Dimension imageSize)
Deprecated.
Use Presentation.GetThumbnails(IRenderingOptions, Size) instead. The method will be removed after release of version 21.4.
|
java.awt.image.BufferedImage[] |
getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
float scaleX,
float scaleY)
Deprecated.
Use Presentation.GetThumbnails(IRenderingOptions, float, float) instead. The method will be removed after release of version 21.4.
|
java.awt.image.BufferedImage[] |
getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
int[] slides)
Deprecated.
Use Presentation.GetThumbnails(IRenderingOptions, int[]) instead. The method will be removed after release of version 21.4.
|
java.awt.image.BufferedImage[] |
getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
int[] slides,
java.awt.Dimension imageSize)
Deprecated.
Use Presentation.getThumbnails(IRenderingOptions, int[], Dimension) instead. The method will be removed after release of version 21.4.
|
java.awt.image.BufferedImage[] |
getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting,
int[] slides,
float scaleX,
float scaleY)
Deprecated.
Use Presentation.GetThumbnails(IRenderingOptions, int[], float, float) instead. The method will be removed after release of version 21.4.
|
java.awt.image.BufferedImage[] |
getThumbnails(IRenderingOptions options)
Returns a Thumbnail BufferedImage objects for all slides of a presentation.
|
java.awt.image.BufferedImage[] |
getThumbnails(IRenderingOptions options,
java.awt.Dimension imageSize)
Returns a Thumbnail BufferedImage objects for all slides of a presentation with specified size.
|
java.awt.image.BufferedImage[] |
getThumbnails(IRenderingOptions options,
float scaleX,
float scaleY)
Returns a Thumbnail BufferedImage objects for all slides of a presentation with custom scaling.
|
java.awt.image.BufferedImage[] |
getThumbnails(IRenderingOptions options,
int[] slides)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation.
|
java.awt.image.BufferedImage[] |
getThumbnails(IRenderingOptions options,
int[] slides,
java.awt.Dimension imageSize)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation with specified size.
|
java.awt.image.BufferedImage[] |
getThumbnails(IRenderingOptions options,
int[] slides,
float scaleX,
float scaleY)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation with custom scaling.
|
IVbaProject |
getVbaProject()
Gets or sets VBA project with presentation macros.
|
IVideoCollection |
getVideos()
Returns the collection of all embedded video files in the presentation.
|
IViewProperties |
getViewProperties()
Gets presentation wide view properties.
|
void |
joinPortionsWithSameFormatting()
Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides.
|
void |
save(IXamlOptions options)
Saves all slides of a presentation to a set of files representing XAML markup.
|
void |
save(java.io.OutputStream stream,
int format)
Saves all slides of a presentation to a stream in the specified format.
|
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.
|
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.
|
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.
|
void |
save(java.lang.String fname,
int format)
Saves all slides of a presentation to a file with the specified format.
|
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.
|
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.
|
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.
|
void |
setCurrentDateTime(java.util.Date value)
Returns or sets date and time which will substitute content of datetime fields.
|
void |
setFirstSlideNumber(int value)
Represents the first slide number in the presentation
|
void |
setVbaProject(IVbaProject value)
Gets or sets VBA project with presentation macros.
|
public Presentation()
This constructor creates new presentation from scratch. Created presentation has one empty slide.
public Presentation(LoadOptions loadOptions)
This constructor creates new presentation from scratch. Created presentation has one empty slide.
loadOptions - Additional load options.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();
stream - Input stream.public Presentation(java.io.InputStream stream,
LoadOptions loadOptions)
This constructor is the primary mechanism for reading an existing Presentation.
stream - Input stream.loadOptions - Additional load options.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");
file - Input file.com.aspose.ms.System.ArgumentException - Thrown when input file has zero lengthpublic Presentation(java.lang.String file,
LoadOptions loadOptions)
This constructor gets a source file path from which the contents of the Presentation are read.
file - Input file.loadOptions - Additional load options.com.aspose.ms.System.ArgumentException - Thrown when input file has zero lengthpublic 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.
getCurrentDateTime in interface IPresentationpublic 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.
setCurrentDateTime in interface IPresentationpublic final com.aspose.slides.IDOMObject getParent_Immediate()
Returns Parent_Immediate object.
Read-only IDOMObject.
public final IPresentationHeaderFooterManager getHeaderFooterManager()
Returns actual HeaderFooter manager.
Read-only IPresentationHeaderFooterManager.
getHeaderFooterManager in interface IPresentationpublic final IProtectionManager getProtectionManager()
Gets manager of the permissions for this presentation.
Read-only IProtectionManager.
getProtectionManager in interface IPresentationpublic final ISlideCollection getSlides()
Returns a list of all slides that are defined in the presentation.
Read-only ISlideCollection.
getSlides in interface IPresentationpublic final ISectionCollection getSections()
Returns a list of all slides sections that are defined in the presentation.
Read-only ISectionCollection.
getSections in interface IPresentationpublic final ISlideSize getSlideSize()
Returns slide size object.
Read-only ISlideSize.
getSlideSize in interface IPresentationpublic final INotesSize getNotesSize()
Returns notes slide size object.
Read-only INotesSize.
getNotesSize in interface IPresentationpublic final IGlobalLayoutSlideCollection getLayoutSlides()
Returns a list of all layout slides that are defined in the presentation.
Read-only IGlobalLayoutSlideCollection.
getLayoutSlides in interface IPresentationpublic final IMasterSlideCollection getMasters()
Returns a list of all master slides that are defined in the presentation.
Read-only IMasterSlideCollection.
getMasters in interface IPresentationpublic final IMasterNotesSlideManager getMasterNotesSlideManager()
Returns notes master manager.
Read-only IMasterNotesSlideManager.
getMasterNotesSlideManager in interface IPresentationpublic final IMasterHandoutSlideManager getMasterHandoutSlideManager()
Returns handout master manager.
Read-only IMasterHandoutSlideManager.
getMasterHandoutSlideManager in interface IPresentationpublic final IFontsManager getFontsManager()
Returns fonts manager.
Read-only IFontsManager.
getFontsManager in interface IPresentationpublic final ITextStyle getDefaultTextStyle()
Returns default text style for shapes.
Read-only ITextStyle.
getDefaultTextStyle in interface IPresentationpublic final ICommentAuthorCollection getCommentAuthors()
Returns the collection of comments autors.
Read-only ICommentAuthorCollection.
getCommentAuthors in interface IPresentationpublic final IDocumentProperties getDocumentProperties()
Returns DocumentProperties object which contains standard and custom document properties.
Read-only IDocumentProperties.
getDocumentProperties in interface IPresentationpublic final IImageCollection getImages()
Returns the collection of all images in the presentation.
Read-only IImageCollection.
getImages in interface IPresentationpublic final IAudioCollection getAudios()
Returns the collection of all embedded audio files in the presentation.
Read-only IAudioCollection.
getAudios in interface IPresentationpublic final IVideoCollection getVideos()
Returns the collection of all embedded video files in the presentation.
Read-only IVideoCollection.
getVideos in interface IPresentationpublic final IDigitalSignatureCollection getDigitalSignatures()
Returns the collection of signatures used to sign the presentation.
Read-only IDigitalSignatureCollection.
Presentation pres = new Presentation("SomePresentationSigned.pptx"); try { if (pres.getDigitalSignatures().size() > 0) { boolean allSignaturesAreValid = true; System.out.println("Signatures used to sign the presentation: "); for (IDigitalSignature signature : pres.getDigitalSignatures()) { System.out.println(signature.getCertificate().hashCode() + ", " + signature.getSignTime().toString() + " -- " + (signature.isValid() ? "VALID" : "INVALID")); allSignaturesAreValid &= signature.isValid(); } if (allSignaturesAreValid) System.out.println("Presentation is genuine, all signatures are valid."); else System.out.println("Presentation has been modified since signing."); } } finally { if (pres != null) pres.dispose(); }
getDigitalSignatures in interface IPresentationpublic final ICustomData getCustomData()
Returns the presentation's custom data.
Read-only ICustomData.
getCustomData in interface IPresentationpublic final ICustomXmlPart[] getAllCustomXmlParts()
Returns all custom data parts in the presentaion.
Read-only ICustomXmlPart[].
getAllCustomXmlParts in interface IPresentationpublic final IVbaProject getVbaProject()
Gets or sets VBA project with presentation macros.
Read/write IVbaProject.
getVbaProject in interface IPresentationpublic final void setVbaProject(IVbaProject value)
Gets or sets VBA project with presentation macros.
Read/write IVbaProject.
setVbaProject in interface IPresentationpublic final IHyperlinkQueries getHyperlinkQueries()
Provides easy access to all hyperlinks contained in all presentation slides (not in master, layout, notes slides).
Read-only IHyperlinkQueries.
getHyperlinkQueries in interface IPresentationpublic final IViewProperties getViewProperties()
Gets presentation wide view properties.
Read-only IViewProperties.
getViewProperties in interface IPresentationpublic final int getFirstSlideNumber()
Represents the first slide number in the presentation
getFirstSlideNumber in interface IPresentationpublic final void setFirstSlideNumber(int value)
Represents the first slide number in the presentation
setFirstSlideNumber in interface IPresentationpublic final IBaseSlide getSlideById(long id)
Returns a Slide, MasterSlide or LayoutSlide by Id.
getSlideById in interface IPresentationid - Id of a slide.public final int getSourceFormat()
Returns information about from which format presentation was loaded.
Read-only SourceFormat.
getSourceFormat in interface IPresentationpublic final IMasterTheme getMasterTheme()
Returns master theme.
Read-only IMasterTheme.
getMasterTheme in interface IPresentationpublic final void save(java.lang.String fname,
int format)
Saves all slides of a presentation to a file with the specified format.
save in interface IPresentationfname - Path to the created file.format - Format of the exported data.public final void save(java.io.OutputStream stream,
int format)
Saves all slides of a presentation to a stream in the specified format.
save in interface IPresentationstream - Output stream.format - Format of the exported data.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.
save in interface IPresentationfname - Path to the created file.format - Format of the exported data.options - Additional format options.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.
save in interface IPresentationstream - Output stream.format - Format of the exported data.options - Additional format options.com.aspose.ms.System.NotSupportedException - If you try to save encrypted file in
none Office 2007-2010 formatpublic final void save(IXamlOptions options)
Saves all slides of a presentation to a set of files representing XAML markup.
Presentation pres = new Presentation("pres.pptx"); try { XamlOptions xamlOptions = new XamlOptions(); xamlOptions.setExportHiddenSlides(true); pres.save(xamlOptions); } finally { if (pres != null) pres.dispose(); }
save in interface IPresentationoptions - The XAML format options.@Deprecated public final java.awt.image.BufferedImage[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting)
Returns a Thumbnail BufferedImage objects for all slides of a presentation.
getThumbnails in interface IPresentationnotesCommentsLayouting - Options for notes and comments layouting.@Deprecated public final java.awt.image.BufferedImage[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting, int[] slides)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation.
getThumbnails in interface IPresentationnotesCommentsLayouting - Options for notes and comments layouting.slides - Array with slide positions, starting from 1.@Deprecated public final java.awt.image.BufferedImage[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting, float scaleX, float scaleY)
Returns a Thumbnail BufferedImage objects for all slides of a presentation with custom scaling.
getThumbnails in interface IPresentationnotesCommentsLayouting - 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.@Deprecated public final java.awt.image.BufferedImage[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting, int[] slides, float scaleX, float scaleY)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation with custom scaling.
getThumbnails in interface IPresentationnotesCommentsLayouting - 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.@Deprecated public final java.awt.image.BufferedImage[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting, java.awt.Dimension imageSize)
Returns a Thumbnail BufferedImage objects for all slides of a presentation with specified size.
getThumbnails in interface IPresentationnotesCommentsLayouting - Options for notes and comments layouting.imageSize - Size of the image to create.@Deprecated public final java.awt.image.BufferedImage[] getThumbnails(INotesCommentsLayoutingOptions notesCommentsLayouting, int[] slides, java.awt.Dimension imageSize)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation with specified size.
getThumbnails in interface IPresentationnotesCommentsLayouting - Options for notes and comments layouting.slides - Array with slide positions, starting from 1.imageSize - Size of the image to create.public final java.awt.image.BufferedImage[] getThumbnails(IRenderingOptions options)
Returns a Thumbnail BufferedImage objects for all slides of a presentation.
getThumbnails in interface IPresentationoptions - Tiff options.public final java.awt.image.BufferedImage[] getThumbnails(IRenderingOptions options, int[] slides)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation.
getThumbnails in interface IPresentationoptions - Tiff options.slides - Array with slide positions, starting from 1.public final java.awt.image.BufferedImage[] getThumbnails(IRenderingOptions options, float scaleX, float scaleY)
Returns a Thumbnail BufferedImage objects for all slides of a presentation with custom scaling.
getThumbnails in interface IPresentationoptions - Tiff options.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.public final java.awt.image.BufferedImage[] getThumbnails(IRenderingOptions options, int[] slides, float scaleX, float scaleY)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation with custom scaling.
getThumbnails in interface IPresentationoptions - Tiff options.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.public final java.awt.image.BufferedImage[] getThumbnails(IRenderingOptions options, java.awt.Dimension imageSize)
Returns a Thumbnail BufferedImage objects for all slides of a presentation with specified size.
getThumbnails in interface IPresentationoptions - Tiff options.imageSize - Size of the image to create.public final java.awt.image.BufferedImage[] getThumbnails(IRenderingOptions options, int[] slides, java.awt.Dimension imageSize)
Returns a Thumbnail BufferedImage objects for specified slides of a presentation with specified size.
getThumbnails in interface IPresentationoptions - Tiff options.slides - Array with slide positions, starting from 1.imageSize - Size of the image to create.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.
save in interface IPresentationfname - Path to the created file.slides - Array with slide positions, starting from 1.format - Format of the exported data.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.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.
save in interface IPresentationfname - Path to the created file.slides - Array with slide positions, starting from 1.format - Format of the exported data.options - Additional format options.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.
save in interface IPresentationstream - Output stream.slides - Array with slide positions, starting from 1.format - Format of the exported data.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.
save in interface IPresentationstream - Output stream.slides - Array with slide positions, starting from 1.format - Format of the exported data.options - Additional format options.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.public final void joinPortionsWithSameFormatting()
Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides.
joinPortionsWithSameFormatting in interface IPresentationpublic final void dispose()
Releases all resources used by this Presentation object.
dispose in interface com.aspose.ms.System.IDisposablepublic final IPresentation getPresentation()
Returns the parent presentation of a text.
Read-only IPresentation.
getPresentation in interface IPresentationComponentCopyright © 2004-2022 Aspose Pty Ltd. All Rights Reserved.