|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.slides.Presentation
public final class Presentation
Represents a Microsoft PowerPoint presentation.
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.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. |
Method Summary | |
---|---|
void |
dispose()
Releases all resources used by this Aspose.Slides.Pptx.PrentationEx object. |
void |
encrypt(java.lang.String password)
Deprecated. |
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, if UpdateDateTimeFields is true. |
ICustomData |
getCustomData()
Returns the presentation's custom data. |
ITextStyle |
getDefaultTextStyle()
Returns default text style for shapes. |
IDocumentProperties |
getDocumentProperties()
Returns DocumentProperties object which contains standard and custom document properties. |
boolean |
getEncryptDocumentProperties()
Deprecated. |
int |
getFirstSlideNumber()
Represents the first slide number in the presentation |
IFontsManager |
getFontsManager()
Returns fonts manager. |
IHeaderFooterManager |
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. |
static PresentationText |
getPresentationText(java.io.InputStream stream,
int mode)
Retreieves the raw text from the slides |
static PresentationText |
getPresentationText(java.io.InputStream stream,
int mode,
LoadOptions options)
Retreieves the raw text from the slides |
static PresentationText |
getPresentationText(java.lang.String file,
int mode)
Retreieves the raw text from the slides |
IProtectionManager |
getProtectionManager()
Gets manager of the permissions for this 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. |
ITagCollection |
getTags()
Deprecated. |
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. |
boolean |
isEncrypted()
Deprecated. |
boolean |
isOnlyDocumentPropertiesLoaded()
Deprecated. |
boolean |
isWriteProtected()
Deprecated. |
void |
joinPortionsWithSameFormatting()
Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides. |
void |
removeEncryption()
Deprecated. |
void |
removeWriteProtection()
Deprecated. |
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, if UpdateDateTimeFields is true. |
void |
setEncryptDocumentProperties(boolean value)
Deprecated. |
void |
setFirstSlideNumber(int value)
Represents the first slide number in the presentation |
void |
setVbaProject(IVbaProject value)
Gets or sets VBA project with presentation macros. |
void |
setWriteProtection(java.lang.String password)
Deprecated. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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.
- Parameters:
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.
- Parameters:
file
- Input file.
public 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.Method Detail |
---|
public java.util.Date getCurrentDateTime()
Returns or sets date and time which will substitute content of datetime fields, if UpdateDateTimeFields
is true.
Time of this Presentation object creation by default.
Read/write java.util.Date
.
getCurrentDateTime
in interface IPresentation
public void setCurrentDateTime(java.util.Date value)
Returns or sets date and time which will substitute content of datetime fields, if UpdateDateTimeFields
is true.
Time of this Presentation object creation by default.
Read/write java.util.Date
.
setCurrentDateTime
in interface IPresentation
public com.aspose.slides.IDOMObject getParent_Immediate()
Returns Parent_Immediate object.
Read-only IDOMObject
.
public IHeaderFooterManager getHeaderFooterManager()
Returns actual HeaderFooter manager.
Read-only IHeaderFooterManager
.
getHeaderFooterManager
in interface IPresentation
public static PresentationText getPresentationText(java.lang.String file, int mode)
Retreieves the raw text from the slides
file
- Input filemode
- Extraction mode
public static PresentationText getPresentationText(java.io.InputStream stream, int mode)
Retreieves the raw text from the slides
stream
- Input streammode
- Extraction mode
public static PresentationText getPresentationText(java.io.InputStream stream, int mode, LoadOptions options)
Retreieves the raw text from the slides
stream
- Input streammode
- Extraction modeoptions
- Load options
public IProtectionManager getProtectionManager()
Gets manager of the permissions for this presentation.
Read-only IProtectionManager
.
getProtectionManager
in interface IPresentation
@Deprecated public boolean getEncryptDocumentProperties()
This property makes sense, if presentation is password protected.
If true then document properties is encrypted in presentation file.
If false then document properties is public while presentation is encrypted.
Read/write boolean
.
@Deprecated public void setEncryptDocumentProperties(boolean value)
This property makes sense, if presentation is password protected.
If true then document properties is encrypted in presentation file.
If false then document properties is public while presentation is encrypted.
Read/write boolean
.
@Deprecated public boolean isEncrypted()
Gets a value indicating whether this instance is encrypted.
Read-only boolean
.
true
if presentation was loaded from encrypted file or Encrypt(string)
method was called ; otherwise, false
.
@Deprecated public boolean isOnlyDocumentPropertiesLoaded()
This property makes sense, if presentation file is password protected and document
properties of this file are public.
Value of true means that only document properties are loaded from an encrypted
presentation file without use of password.
Value of false means that entire encrypted presentation is loaded with use of right
password, not only document properties are loaded.
If presentation isn't encrypted then property value is always false.
If document properties of an encrypted file aren't public then property value is always false.
If Presentation.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded
property value is always false.
Read-only boolean
.
@Deprecated public boolean isWriteProtected()
Gets a value indicating whether this presentation is write protected.
Read-only boolean
.
@Deprecated public void encrypt(java.lang.String password)
Encrypts Presentation with specified password.
password
- The password.@Deprecated public void removeEncryption()
Removes the encryption.
@Deprecated public void setWriteProtection(java.lang.String password)
Set write protection for this presentation with specified password.
password
- The password.@Deprecated public void removeWriteProtection()
Removes write protection for this presentation.
public ISlideCollection getSlides()
Returns a list of all slides that are defined in the presentation.
Read-only ISlideCollection
.
getSlides
in interface IPresentation
public ISlideSize getSlideSize()
Returns slide size object.
Read-only ISlideSize
.
getSlideSize
in interface IPresentation
public final INotesSize getNotesSize()
Returns notes slide size object.
Read-only INotesSize
.
getNotesSize
in interface IPresentation
public IGlobalLayoutSlideCollection getLayoutSlides()
Returns a list of all layout slides that are defined in the presentation.
Read-only IGlobalLayoutSlideCollection
.
getLayoutSlides
in interface IPresentation
public IMasterSlideCollection getMasters()
Returns a list of all master slides that are defined in the presentation.
Read-only IMasterSlideCollection
.
getMasters
in interface IPresentation
public IMasterNotesSlideManager getMasterNotesSlideManager()
Returns notes master manager.
Read-only IMasterNotesSlideManager
.
getMasterNotesSlideManager
in interface IPresentation
public IMasterHandoutSlideManager getMasterHandoutSlideManager()
Returns handout master manager.
Read-only IMasterHandoutSlideManager
.
getMasterHandoutSlideManager
in interface IPresentation
public IFontsManager getFontsManager()
Returns fonts manager.
Read-only IFontsManager
.
getFontsManager
in interface IPresentation
public ITextStyle getDefaultTextStyle()
Returns default text style for shapes.
Read-only ITextStyle
.
getDefaultTextStyle
in interface IPresentation
public ICommentAuthorCollection getCommentAuthors()
Returns the collection of comments autors.
Read-only ICommentAuthorCollection
.
getCommentAuthors
in interface IPresentation
public IDocumentProperties getDocumentProperties()
Returns DocumentProperties object which contains standard and custom document properties.
Read-only IDocumentProperties
.
getDocumentProperties
in interface IPresentation
public IImageCollection getImages()
Returns the collection of all images in the presentation.
Read-only IImageCollection
.
getImages
in interface IPresentation
public IAudioCollection getAudios()
Returns the collection of all embedded audio files in the presentation.
Read-only IAudioCollection
.
getAudios
in interface IPresentation
public IVideoCollection getVideos()
Returns the collection of all embedded video files in the presentation.
Read-only IVideoCollection
.
getVideos
in interface IPresentation
@Deprecated public ITagCollection getTags()
Returns the presentation's tags collection.
Read-only ITagCollection
.
public ICustomData getCustomData()
Returns the presentation's custom data.
Read-only ICustomData
.
getCustomData
in interface IPresentation
public IVbaProject getVbaProject()
Gets or sets VBA project with presentation macros.
Read/write IVbaProject
.
getVbaProject
in interface IPresentation
public void setVbaProject(IVbaProject value)
Gets or sets VBA project with presentation macros.
Read/write IVbaProject
.
setVbaProject
in interface IPresentation
public 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 IPresentation
public IViewProperties getViewProperties()
Gets presentation wide view properties.
Read-only IViewProperties
.
getViewProperties
in interface IPresentation
public final int getFirstSlideNumber()
Represents the first slide number in the presentation
getFirstSlideNumber
in interface IPresentation
public final void setFirstSlideNumber(int value)
Represents the first slide number in the presentation
setFirstSlideNumber
in interface IPresentation
public final IBaseSlide getSlideById(long id)
Returns a Slide, MasterSlide or LayoutSlide by Id.
getSlideById
in interface IPresentation
id
- Id of a slide.
public int getSourceFormat()
Returns information about from which format presentation was loaded.
Read-only SourceFormat
.
getSourceFormat
in interface IPresentation
public IMasterTheme getMasterTheme()
Returns master theme.
Read-only IMasterTheme
.
getMasterTheme
in interface IPresentation
public void save(java.lang.String fname, int format)
Saves all slides of a presentation to a file with the specified format.
save
in interface IPresentation
fname
- Path to the created file.format
- Format of the exported data.public void save(java.io.OutputStream stream, int format)
Saves all slides of a presentation to a stream in the specified format.
save
in interface IPresentation
stream
- Output stream.format
- Format of the exported data.public 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 IPresentation
fname
- Path to the created file.format
- Format of the exported data.options
- Additional format options.public 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 IPresentation
stream
- 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 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 IPresentation
fname
- 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 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 IPresentation
fname
- Path to the created file.slides
- Array with slide positions, starting from 1.format
- Format of the exported data.options
- Additional format options.public 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 IPresentation
stream
- Output stream.slides
- Array with slide positions, starting from 1.format
- Format of the exported data.public 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 IPresentation
stream
- 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 void joinPortionsWithSameFormatting()
Joins runs with same formatting in all paragraphs in all acceptable shapes in all slides.
joinPortionsWithSameFormatting
in interface IPresentation
public final void dispose()
Releases all resources used by this Aspose.Slides.Pptx.PrentationEx object.
dispose
in interface com.aspose.ms.System.IDisposable
public IPresentation getPresentation()
Returns the parent presentation of a text.
Read-only IPresentation
.
getPresentation
in interface IPresentationComponent
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |