PresentationLoadOptions

Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions

All Implemented Interfaces: java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

public class PresentationLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions, IDocumentsContainerLoadOptions

Options for loading Presentation documents.

Constructors

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

Methods

Method Description
getFormat()
getDefaultFont() Default font for rendering the presentation.
setDefaultFont(String value) Default font for rendering the presentation.
getFontSubstitutes() Substitute specific fonts when converting Presentation document.
setFontSubstitutes(List value) Substitute specific fonts when converting Presentation document.
getPassword() Set password to unprotect protected document.
setPassword(String value) Set password to unprotect protected document.
getHideComments() Hide comments.
setHideComments(boolean value) Hide comments.
getShowHiddenSlides() Show hidden slides.
setShowHiddenSlides(boolean value) Show hidden slides.
getSkipExternalResources() {@inheritDoc}
setSkipExternalResources(boolean skip) {@inheritDoc}
getWhitelistedResources() {@inheritDoc}
setWhitelistedResources(List whiteList) {@inheritDoc}
getDocumentFontSources()
setDocumentFontSources(List documentFontSources)
getNotesPosition() Represents the way comments are printed with the slide.
setNotesPosition(PresentationNotesPosition notesPosition) Represents the way notes are printed with the slide.
getCommentsPosition()
setCommentsPosition(PresentationCommentsPosition commentsPosition)
isConvertOwner()
setConvertOwner(boolean convertOwner)
isConvertOwned()
setConvertOwned(boolean convertOwned)
getDepth()
setDepth(int depth)

PresentationLoadOptions()

public PresentationLoadOptions()

Initializes new instance of EmailLoadOptions class.

getFormat()

public final PresentationFileType getFormat()

Input document file type

Returns: PresentationFileType

getDefaultFont()

public final String getDefaultFont()

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

Returns: java.lang.String

setDefaultFont(String value)

public final void setDefaultFont(String value)

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

Parameters:

Parameter Type Description
value java.lang.String

getFontSubstitutes()

public final List<FontSubstitute> getFontSubstitutes()

Substitute specific fonts when converting Presentation document.

Returns: java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>

setFontSubstitutes(List value)

public final void setFontSubstitutes(List<FontSubstitute> value)

Substitute specific fonts when converting Presentation document.

Parameters:

Parameter Type Description
value java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>

getPassword()

public final String getPassword()

Set password to unprotect protected document.

Returns: java.lang.String

setPassword(String value)

public final void setPassword(String value)

Set password to unprotect protected document.

Parameters:

Parameter Type Description
value java.lang.String

getHideComments()

public final boolean getHideComments()

Hide comments.

Returns: boolean

setHideComments(boolean value)

public final void setHideComments(boolean value)

Hide comments.

Parameters:

Parameter Type Description
value boolean

getShowHiddenSlides()

public final boolean getShowHiddenSlides()

Show hidden slides.

Returns: boolean

setShowHiddenSlides(boolean value)

public final void setShowHiddenSlides(boolean value)

Show hidden slides.

Parameters:

Parameter Type Description
value boolean

getSkipExternalResources()

public boolean getSkipExternalResources()

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

Returns: boolean

setSkipExternalResources(boolean skip)

public void setSkipExternalResources(boolean skip)

Parameters:

Parameter Type Description
skip boolean

getWhitelistedResources()

public List<String> getWhitelistedResources()

External resources that will be always loaded

Returns: java.util.List<java.lang.String>

setWhitelistedResources(List whiteList)

public void setWhitelistedResources(List<String> whiteList)

Parameters:

Parameter Type Description
whiteList java.util.List<java.lang.String>

getDocumentFontSources()

public List<String> getDocumentFontSources()

Returns: java.util.List<java.lang.String>

setDocumentFontSources(List documentFontSources)

public void setDocumentFontSources(List<String> documentFontSources)

Parameters:

Parameter Type Description
documentFontSources java.util.List<java.lang.String>

getNotesPosition()

public PresentationNotesPosition getNotesPosition()

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

Returns: PresentationNotesPosition

setNotesPosition(PresentationNotesPosition notesPosition)

public void setNotesPosition(PresentationNotesPosition notesPosition)

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

Parameters:

Parameter Type Description
notesPosition PresentationNotesPosition

getCommentsPosition()

public PresentationCommentsPosition getCommentsPosition()

Returns: PresentationCommentsPosition -

setCommentsPosition(PresentationCommentsPosition commentsPosition)

public void setCommentsPosition(PresentationCommentsPosition commentsPosition)

Parameters:

Parameter Type Description
commentsPosition PresentationCommentsPosition

isConvertOwner()

public boolean isConvertOwner()

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

Returns: boolean

setConvertOwner(boolean convertOwner)

public void setConvertOwner(boolean convertOwner)

Parameters:

Parameter Type Description
convertOwner boolean

isConvertOwned()

public boolean isConvertOwned()

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

Returns: boolean

setConvertOwned(boolean convertOwned)

public void setConvertOwned(boolean convertOwned)

Parameters:

Parameter Type Description
convertOwned boolean

getDepth()

public int getDepth()

Option to control how many levels in depth to perform conversion

Returns: int

setDepth(int depth)

public void setDepth(int depth)

Parameters:

Parameter Type Description
depth int