PdfLoadOptions Leave feedback
On this page
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.IPageNumberingLoadOptions, com.groupdocs.conversion.contracts.IDocumentsContainerLoadOptions
public final class PdfLoadOptions extends LoadOptions implements Serializable, IPageNumberingLoadOptions, IDocumentsContainerLoadOptions
Options for loading Pdf documents.
| Constructor | Description |
|---|---|
| PdfLoadOptions() | Initializes new instance of PdfLoadOptions class. |
| Method | Description |
|---|---|
| getFormat() | |
| getRemoveEmbeddedFiles() | Remove embedded files. |
| setRemoveEmbeddedFiles(boolean value) | Remove embedded files. |
| getPassword() | Set password to unprotect protected document. |
| setPassword(String value) | Set password to unprotect protected document. |
| getDefaultFont() | Default font for Pdf document. |
| setDefaultFont(String value) | Default font for Pdf document. |
| getFontSubstitutes() | Substitute specific fonts when converting Pdf document. |
| setFontSubstitutes(List |
Substitute specific fonts when converting Pdf document. |
| getHidePdfAnnotations() | Hide annotations in Pdf documents. |
| setHidePdfAnnotations(boolean value) | Hide annotations in Pdf documents. |
| getFlattenAllFields() | Flatten all the fields of the PDF form. |
| setFlattenAllFields(boolean value) | Flatten all the fields of the PDF form. |
| getResetFontFolders() | Reset font folders before loading document. |
| setResetFontFolders(boolean resetFontFolders) | |
| isPageNumbering() | Enable or disable generation of page numbering in converted document. |
| setPageNumbering(boolean isPageNumbering) | |
| isRemoveJavascript() | Gets the Remove JavaScript flag. |
| setRemoveJavascript(boolean removeJavascript) | Sets the Remove JavaScript flag. |
| isConvertOwner() | Specifies whether the owner document should be converted. |
| setConvertOwner(boolean convertOwner) | Specifies whether the owner document should be converted. |
| isConvertOwned() | Specifies whether owned documents should be converted. |
| setConvertOwned(boolean convertOwned) | Specifies whether owned documents should be converted. |
| getDepth() | Maximum depth for processing owned documents. |
| setDepth(int depth) | Maximum depth for processing owned documents. |
public PdfLoadOptions()
Initializes new instance of PdfLoadOptions class.
public final PdfFileType getFormat()
Input document file type
Returns: PdfFileType
public final boolean getRemoveEmbeddedFiles()
Remove embedded files.
Returns: boolean
public final void setRemoveEmbeddedFiles(boolean value)
Remove embedded files.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final String getPassword()
Set password to unprotect protected document.
Returns: java.lang.String
public final void setPassword(String value)
Set password to unprotect protected document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final String getDefaultFont()
Default font for Pdf document. The following font will be used if a font is missing.
Returns: java.lang.String
public final void setDefaultFont(String value)
Default font for Pdf document. The following font will be used if a font is missing.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final List<FontSubstitute> getFontSubstitutes()
Substitute specific fonts when converting Pdf document.
Returns: java.util.List<com.groupdocs.conversion.contracts.FontSubstitute>
public final void setFontSubstitutes(List<FontSubstitute> value)
Substitute specific fonts when converting Pdf document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.List<com.groupdocs.conversion.contracts.FontSubstitute> |
public final boolean getHidePdfAnnotations()
Hide annotations in Pdf documents.
Returns: boolean
public final void setHidePdfAnnotations(boolean value)
Hide annotations in Pdf documents.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getFlattenAllFields()
Flatten all the fields of the PDF form.
Returns: boolean
public final void setFlattenAllFields(boolean value)
Flatten all the fields of the PDF form.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public boolean getResetFontFolders()
Reset font folders before loading document.
Returns: boolean
public void setResetFontFolders(boolean resetFontFolders)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resetFontFolders | boolean |
public boolean isPageNumbering()
Enable or disable generation of page numbering in converted document. Default: false.
Returns: boolean
public void setPageNumbering(boolean isPageNumbering)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| isPageNumbering | boolean |
public boolean isRemoveJavascript()
Gets the Remove JavaScript flag.
Returns: boolean
public void setRemoveJavascript(boolean removeJavascript)
Sets the Remove JavaScript flag.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| removeJavascript | boolean |
public boolean isConvertOwner()
Specifies whether the owner document should be converted.
Default is true .
Returns: boolean
public void setConvertOwner(boolean convertOwner)
Specifies whether the owner document should be converted.
Default is true .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| convertOwner | boolean |
public boolean isConvertOwned()
Specifies whether owned documents should be converted.
Default is false .
Returns: boolean
public void setConvertOwned(boolean convertOwned)
Specifies whether owned documents should be converted.
Default is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| convertOwned | boolean |
public int getDepth()
Maximum depth for processing owned documents.
Default is 2 .
Returns: int
public void setDepth(int depth)
Maximum depth for processing owned documents.
Default is 2 .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| depth | int |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
