com.groupdocs.conversion.options.load

Class PresentationLoadOptions

java.lang.Object

com.groupdocs.conversion.contracts.ValueObject

com.groupdocs.conversion.options.load.LoadOptions

com.groupdocs.conversion.options.load.PresentationLoadOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions, com.groupdocs.conversion.options.load.IResourceLoadingOptions, Serializable

public class PresentationLoadOptions
extends LoadOptions
implements Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Options for loading Presentation documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PresentationLoadOptions() Initializes new instance of EmailLoadOptions class.

Method Summary

Modifier and Type	Method and Description
com.groupdocs.conversion.contracts.PresentationCommentsPosition	getCommentsPosition()
String	getDefaultFont() Default font for rendering the presentation.
int	getDepth() Option to control how many levels in depth to perform conversion
List<String>	getDocumentFontSources()
List<FontSubstitute>	getFontSubstitutes() Substitute specific fonts when converting Presentation document.
PresentationFileType	getFormat() Input document file type
boolean	getHideComments() Hide comments.
com.groupdocs.conversion.contracts.PresentationNotesPosition	getNotesPosition() Represents the way comments are printed with the slide.
String	getPassword() Set password to unprotect protected document.
boolean	getShowHiddenSlides() Show hidden slides.
boolean	getSkipExternalResources() If true all external resource will not be loading with exception of the resources in the
List<String>	getWhitelistedResources() External resources that will be always loaded
boolean	isConvertOwned() Option to control whether the owned documents in the documents container must be converted
boolean	isConvertOwner() Gets option to control whether the documents container itself must be converted
void	setCommentsPosition(com.groupdocs.conversion.contracts.PresentationCommentsPosition commentsPosition)
void	setConvertOwned(boolean convertOwned)
void	setConvertOwner(boolean convertOwner)
void	setDefaultFont(String value) Default font for rendering the presentation.
void	setDepth(int depth)
void	setDocumentFontSources(List<String> documentFontSources)
void	setFontSubstitutes(List<FontSubstitute> value) Substitute specific fonts when converting Presentation document.
void	setHideComments(boolean value) Hide comments.
void	setNotesPosition(com.groupdocs.conversion.contracts.PresentationNotesPosition notesPosition) Represents the way notes are printed with the slide.
void	setPassword(String value) Set password to unprotect protected document.
void	setShowHiddenSlides(boolean value) Show hidden slides.
void	setSkipExternalResources(boolean skip)
void	setWhitelistedResources(List<String> whiteList)

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions

setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

equals, equals, hashCode, op_Equality, op_Inequality

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PresentationLoadOptions

public PresentationLoadOptions()

Initializes new instance of EmailLoadOptions class.

Method Detail

getFormat

public final PresentationFileType getFormat()

Description copied from class: LoadOptions

Input document file type

Overrides:

getFormat in class LoadOptions

getDefaultFont

public final String getDefaultFont()

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

setDefaultFont

public final void setDefaultFont(String value)

Default font for rendering the presentation. The following font will be used if a presentation font is missing.

getFontSubstitutes

public final List<FontSubstitute> getFontSubstitutes()

Substitute specific fonts when converting Presentation document.

setFontSubstitutes

public final void setFontSubstitutes(List<FontSubstitute> value)

Substitute specific fonts when converting Presentation document.

getPassword

public final String getPassword()

Set password to unprotect protected document.

setPassword

public final void setPassword(String value)

Set password to unprotect protected document.

getHideComments

public final boolean getHideComments()

Hide comments.

setHideComments

public final void setHideComments(boolean value)

Hide comments.

getShowHiddenSlides

public final boolean getShowHiddenSlides()

Show hidden slides.

setShowHiddenSlides

public final void setShowHiddenSlides(boolean value)

Show hidden slides.

getSkipExternalResources

public boolean getSkipExternalResources()

If true all external resource will not be loading with exception of the resources in the

Specified by:

getSkipExternalResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

setSkipExternalResources

public void setSkipExternalResources(boolean skip)

Specified by:

setSkipExternalResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

getWhitelistedResources

public List<String> getWhitelistedResources()

External resources that will be always loaded

Specified by:

getWhitelistedResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

setWhitelistedResources

public void setWhitelistedResources(List<String> whiteList)

Specified by:

setWhitelistedResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

getDocumentFontSources

public List<String> getDocumentFontSources()

setDocumentFontSources

public void setDocumentFontSources(List<String> documentFontSources)

getNotesPosition

public com.groupdocs.conversion.contracts.PresentationNotesPosition getNotesPosition()

Represents the way comments are printed with the slide. Default is None.

setNotesPosition

public void setNotesPosition(com.groupdocs.conversion.contracts.PresentationNotesPosition notesPosition)

Represents the way notes are printed with the slide. Default is None.

getCommentsPosition

public com.groupdocs.conversion.contracts.PresentationCommentsPosition getCommentsPosition()

Returns:

setCommentsPosition

public void setCommentsPosition(com.groupdocs.conversion.contracts.PresentationCommentsPosition commentsPosition)

isConvertOwner

public boolean isConvertOwner()

Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Gets option to control whether the documents container itself must be converted

Specified by:

isConvertOwner in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Returns:

If this property is true the documents container will be the first converted document

setConvertOwner

public void setConvertOwner(boolean convertOwner)

isConvertOwned

public boolean isConvertOwned()

Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Option to control whether the owned documents in the documents container must be converted

Specified by:

isConvertOwned in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Returns:

true if the owned documents in the documents container must be converted

setConvertOwned

public void setConvertOwned(boolean convertOwned)

getDepth

public int getDepth()

Description copied from interface: com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Option to control how many levels in depth to perform conversion

Specified by:

getDepth in interface com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Returns:

depth levels count

setDepth

public void setDepth(int depth)