com.groupdocs.conversion.options.load

Class PdfLoadOptions

java.lang.Object

com.groupdocs.conversion.contracts.ValueObject

com.groupdocs.conversion.options.load.LoadOptions

com.groupdocs.conversion.options.load.PdfLoadOptions

All Implemented Interfaces:

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

public final class PdfLoadOptions
extends LoadOptions
implements Serializable, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions

Options for loading Pdf documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PdfLoadOptions() Initializes new instance of PdfLoadOptions class.

Method Summary

Modifier and Type	Method and Description
String	getDefaultFont() Default font for Pdf document.
int	getDepth() Maximum depth for processing owned documents.
boolean	getFlattenAllFields() Flatten all the fields of the PDF form.
List<FontSubstitute>	getFontSubstitutes() Substitute specific fonts when converting Pdf document.
PdfFileType	getFormat() Input document file type
boolean	getHidePdfAnnotations() Hide annotations in Pdf documents.
String	getPassword() Set password to unprotect protected document.
boolean	getRemoveEmbeddedFiles() Remove embedded files.
boolean	getResetFontFolders() Reset font folders before loading document.
boolean	isConvertOwned() Specifies whether owned documents should be converted.
boolean	isConvertOwner() Specifies whether the owner document should be converted.
boolean	isPageNumbering() Enable or disable generation of page numbering in converted document.
boolean	isRemoveJavascript() Gets the Remove JavaScript flag.
void	setConvertOwned(boolean convertOwned) Specifies whether owned documents should be converted.
void	setConvertOwner(boolean convertOwner) Specifies whether the owner document should be converted.
void	setDefaultFont(String value) Default font for Pdf document.
void	setDepth(int depth) Maximum depth for processing owned documents.
void	setFlattenAllFields(boolean value) Flatten all the fields of the PDF form.
void	setFontSubstitutes(List<FontSubstitute> value) Substitute specific fonts when converting Pdf document.
void	setHidePdfAnnotations(boolean value) Hide annotations in Pdf documents.
void	setPageNumbering(boolean isPageNumbering)
void	setPassword(String value) Set password to unprotect protected document.
void	setRemoveEmbeddedFiles(boolean value) Remove embedded files.
void	setRemoveJavascript(boolean removeJavascript) Sets the Remove JavaScript flag.
void	setResetFontFolders(boolean resetFontFolders)

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

PdfLoadOptions

public PdfLoadOptions()

Initializes new instance of PdfLoadOptions class.

Method Detail

getFormat

public final PdfFileType getFormat()

Description copied from class: LoadOptions

Input document file type

Overrides:

getFormat in class LoadOptions

getRemoveEmbeddedFiles

public final boolean getRemoveEmbeddedFiles()

Remove embedded files.

setRemoveEmbeddedFiles

public final void setRemoveEmbeddedFiles(boolean value)

Remove embedded files.

getPassword

public final String getPassword()

Set password to unprotect protected document.

setPassword

public final void setPassword(String value)

Set password to unprotect protected document.

getDefaultFont

public final String getDefaultFont()

Default font for Pdf document. The following font will be used if a font is missing.

setDefaultFont

public final void setDefaultFont(String value)

Default font for Pdf document. The following font will be used if a font is missing.

getFontSubstitutes

public final List<FontSubstitute> getFontSubstitutes()

Substitute specific fonts when converting Pdf document.

setFontSubstitutes

public final void setFontSubstitutes(List<FontSubstitute> value)

Substitute specific fonts when converting Pdf document.

getHidePdfAnnotations

public final boolean getHidePdfAnnotations()

Hide annotations in Pdf documents.

setHidePdfAnnotations

public final void setHidePdfAnnotations(boolean value)

Hide annotations in Pdf documents.

getFlattenAllFields

public final boolean getFlattenAllFields()

Flatten all the fields of the PDF form.

setFlattenAllFields

public final void setFlattenAllFields(boolean value)

Flatten all the fields of the PDF form.

getResetFontFolders

public boolean getResetFontFolders()

Reset font folders before loading document.

setResetFontFolders

public void setResetFontFolders(boolean resetFontFolders)

isPageNumbering

public boolean isPageNumbering()

Enable or disable generation of page numbering in converted document. Default: false.

Specified by:

isPageNumbering in interface com.groupdocs.conversion.options.load.IPageNumberingLoadOptions

setPageNumbering

public void setPageNumbering(boolean isPageNumbering)

Specified by:

setPageNumbering in interface com.groupdocs.conversion.options.load.IPageNumberingLoadOptions

isRemoveJavascript

public boolean isRemoveJavascript()

Gets the Remove JavaScript flag.

setRemoveJavascript

public void setRemoveJavascript(boolean removeJavascript)

Sets the Remove JavaScript flag.

isConvertOwner

public boolean isConvertOwner()

Specifies whether the owner document should be converted.

Default is true.

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)

Specifies whether the owner document should be converted.

Default is true.

isConvertOwned

public boolean isConvertOwned()

Specifies whether owned documents should be converted.

Default is false.

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)

Specifies whether owned documents should be converted.

Default is false.

getDepth

public int getDepth()

Maximum depth for processing owned documents.

Default is 2.

Specified by:

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

Returns:

depth levels count

setDepth

public void setDepth(int depth)

Maximum depth for processing owned documents.

Default is 2.