| java.lang.Object | |||
| ↳ | com.pdftron.pdf.OptionsBase | ||
| ↳ | com.pdftron.pdf.ConversionOptions | ||
| ↳ | com.pdftron.pdf.OfficeToPDFOptions | ||
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| enum | OfficeToPDFOptions.DisplayComments | Word document comment options | |||||||||
| enum | OfficeToPDFOptions.StructureTagLevel | Level of detail for structure tags. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
OfficeToPDFOptions()
Constructor.
| |||||||||||
|
OfficeToPDFOptions(String json_string)
Constructor.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
getApplyPageBreaksToSheet()
Gets the value ApplyPageBreaksToSheet from the options object.
| ||||||||||
| boolean |
getDisplayChangeTracking()
Gets the value DisplayChangeTracking from the options object.
| ||||||||||
| OfficeToPDFOptions.DisplayComments |
getDisplayComments()
Gets the value DisplayComments from the options object.
| ||||||||||
| boolean |
getDisplayHiddenText()
Gets the value DisplayHiddenText from the options object.
| ||||||||||
| double |
getExcelDefaultCellBorderWidth()
Gets the value ExcelDefaultCellBorderWidth from the options object.
| ||||||||||
| int |
getExcelMaxAllowedCellCount()
Gets the value ExcelMaxAllowedCellCount from the options object.
| ||||||||||
| boolean |
getHideTotalNumberOfPages()
Gets the value HideTotalNumberOfPages from the options object.
| ||||||||||
| boolean |
getIncludeBookmarks()
Gets the value IncludeBookmarks from the options object.
| ||||||||||
| boolean |
getIncrementalSave()
Gets the value IncrementalSave from the options object.
| ||||||||||
| String |
getLayoutResourcesPluginPath()
Gets the value LayoutResourcesPluginPath from the options object.
| ||||||||||
| String |
getLocale()
Gets the value Locale from the options object.
| ||||||||||
| String |
getPassword()
Gets the value Password from the options object.
| ||||||||||
| String |
getResourceDocPath()
Gets the value ResourceDocPath from the options object.
| ||||||||||
| String |
getSmartSubstitutionPluginPath()
Gets the value SmartSubstitutionPluginPath from the options object.
| ||||||||||
| OfficeToPDFOptions.StructureTagLevel |
getStructureTagLevel()
Gets the value StructureTagLevel from the options object.
| ||||||||||
| String |
getTemplateLeftDelimiter()
Gets the value TemplateLeftDelimiter from the options object.
| ||||||||||
| String |
getTemplateParamsJson()
Gets the value TemplateParamsJson from the options object.
| ||||||||||
| String |
getTemplateRightDelimiter()
Gets the value TemplateRightDelimiter from the options object.
| ||||||||||
| boolean |
getTemplateStrictMode()
Gets the value TemplateStrictMode from the options object.
| ||||||||||
| boolean |
getUpdateTableOfContents()
Gets the value UpdateTableOfContents from the options object.
| ||||||||||
| OfficeToPDFOptions |
setApplyPageBreaksToSheet(boolean value)
Sets the value for ApplyPageBreaksToSheet in the options object.
| ||||||||||
| OfficeToPDFOptions |
setDisplayChangeTracking(boolean value)
Sets the value for DisplayChangeTracking in the options object.
| ||||||||||
| OfficeToPDFOptions |
setDisplayComments(OfficeToPDFOptions.DisplayComments value)
Sets the value for DisplayComments in the options object.
| ||||||||||
| OfficeToPDFOptions |
setDisplayHiddenText(boolean value)
Sets the value for DisplayHiddenText in the options object.
| ||||||||||
| OfficeToPDFOptions |
setExcelDefaultCellBorderWidth(double value)
Sets the value for ExcelDefaultCellBorderWidth in the options object.
| ||||||||||
| OfficeToPDFOptions |
setExcelMaxAllowedCellCount(int value)
Sets the value for ExcelMaxAllowedCellCount in the options object.
| ||||||||||
| OfficeToPDFOptions |
setHideTotalNumberOfPages(boolean value)
Sets the value for HideTotalNumberOfPages in the options object.
| ||||||||||
| OfficeToPDFOptions |
setIncludeBookmarks(boolean value)
Sets the value for IncludeBookmarks in the options object.
| ||||||||||
| OfficeToPDFOptions |
setIncrementalSave(boolean value)
Sets the value for IncrementalSave in the options object.
| ||||||||||
| OfficeToPDFOptions |
setLayoutResourcesPluginPath(String value)
Sets the value for LayoutResourcesPluginPath in the options object.
| ||||||||||
| OfficeToPDFOptions |
setLocale(String value)
Sets the value for Locale in the options object.
| ||||||||||
| OfficeToPDFOptions |
setPassword(String value)
Sets the value for Password in the options object.
| ||||||||||
| OfficeToPDFOptions |
setResourceDocPath(String value)
Sets the value for ResourceDocPath in the options object.
| ||||||||||
| OfficeToPDFOptions |
setSmartSubstitutionPluginPath(String value)
Sets the value for SmartSubstitutionPluginPath in the options object.
| ||||||||||
| OfficeToPDFOptions |
setStructureTagLevel(OfficeToPDFOptions.StructureTagLevel value)
Sets the value for StructureTagLevel in the options object.
| ||||||||||
| OfficeToPDFOptions |
setTemplateLeftDelimiter(String value)
Sets the value for TemplateLeftDelimiter in the options object.
| ||||||||||
| OfficeToPDFOptions |
setTemplateParamsJson(String value)
Sets the value for TemplateParamsJson in the options object.
| ||||||||||
| OfficeToPDFOptions |
setTemplateRightDelimiter(String value)
Sets the value for TemplateRightDelimiter in the options object.
| ||||||||||
| OfficeToPDFOptions |
setTemplateStrictMode(boolean value)
Sets the value for TemplateStrictMode in the options object.
| ||||||||||
| OfficeToPDFOptions |
setUpdateTableOfContents(boolean value)
Sets the value for UpdateTableOfContents in the options object.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.pdftron.pdf.ConversionOptions
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
Public Methods
public boolean getApplyPageBreaksToSheet ()
Gets the value ApplyPageBreaksToSheet from the options object. Whether we should split Excel worksheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large
Returns
- Whether we should split Excel worksheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large
Throws
| PDFNetException |
|---|
public boolean getDisplayChangeTracking ()
Gets the value DisplayChangeTracking from the options object. If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true.
Returns
- If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions.DisplayComments getDisplayComments ()
Gets the value DisplayComments from the options object. Specifies the display of comments that are present in the document. By default, comments will not be displayed.
Returns
- Specifies the display of comments that are present in the document. By default, comments will not be displayed.
Throws
| PDFNetException |
|---|
public boolean getDisplayHiddenText ()
Gets the value DisplayHiddenText from the options object. Display any hidden text that is present in the document (i.e., text that has been marked as 'Hidden' in the font style). By default, hidden text will not be displayed.
Returns
- Display any hidden text that is present in the document (i.e., text that has been marked as 'Hidden' in the font style). By default, hidden text will not be displayed.
Throws
| PDFNetException |
|---|
public double getExcelDefaultCellBorderWidth ()
Gets the value ExcelDefaultCellBorderWidth from the options object. Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel.
Returns
- Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel.
Throws
| PDFNetException |
|---|
public int getExcelMaxAllowedCellCount ()
Gets the value ExcelMaxAllowedCellCount from the options object. Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells.
Returns
- Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells.
Throws
| PDFNetException |
|---|
public boolean getHideTotalNumberOfPages ()
Gets the value HideTotalNumberOfPages from the options object. If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document.
Returns
- If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document.
Throws
| PDFNetException |
|---|
public boolean getIncludeBookmarks ()
Gets the value IncludeBookmarks from the options object. When this option is set to false, Word document bookmarks will not be converted into PDF bookmarks. However, Word headings will still be automatically converted into PDF bookmarks. By default, both Word bookmarks and headings are converted into PDF bookmarks, providing a comprehensive navigation structure within the converted PDF.
Returns
- When this option is set to false, Word document bookmarks will not be converted into PDF bookmarks. However, Word headings will still be automatically converted into PDF bookmarks. By default, both Word bookmarks and headings are converted into PDF bookmarks, providing a comprehensive navigation structure within the converted PDF.
Throws
| PDFNetException |
|---|
public boolean getIncrementalSave ()
Gets the value IncrementalSave from the options object. If this option is true, the document will be saved incrementally during the conversion, thus reducing the peak memory usage. Save an empty PDFDoc to the target location before the conversion so the incremental saving is done directly to the target location. Otherwise, a temporary file will be used. PDFDoc.Save still has to be called after the conversion is done to finalize the file. Doing PDFDoc.Save with e_incremental flag will reduce the saving time but increase the PDF file size.
Returns
- If this option is true, the document will be saved incrementally during the conversion, thus reducing the peak memory usage. Save an empty PDFDoc to the target location before the conversion so the incremental saving is done directly to the target location. Otherwise, a temporary file will be used. PDFDoc.Save still has to be called after the conversion is done to finalize the file. Doing PDFDoc.Save with e_incremental flag will reduce the saving time but increase the PDF file size.
Throws
| PDFNetException |
|---|
public String getLayoutResourcesPluginPath ()
Gets the value LayoutResourcesPluginPath from the options object. The path at which the pdftron-provided font resource plugin resides
Returns
- The path at which the pdftron-provided font resource plugin resides
Throws
| PDFNetException |
|---|
public String getLocale ()
Gets the value Locale from the options object. ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.
Returns
- ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.
Throws
| PDFNetException |
|---|
public String getPassword ()
Gets the value Password from the options object. Password used to decrypt password-protected office documents.
Returns
- Password used to decrypt password-protected office documents.
Throws
| PDFNetException |
|---|
public String getResourceDocPath ()
Gets the value ResourceDocPath from the options object. The path at which a .docx resource document resides
Returns
- The path at which a .docx resource document resides
Throws
| PDFNetException |
|---|
public String getSmartSubstitutionPluginPath ()
Gets the value SmartSubstitutionPluginPath from the options object. The path at which the pdftron-provided font resource plugin resides
Returns
- The path at which the pdftron-provided font resource plugin resides
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions.StructureTagLevel getStructureTagLevel ()
Gets the value StructureTagLevel from the options object. Specifies the level of document structure tags to include in the PDF for accessibility purposes.
Returns
- Specifies the level of document structure tags to include in the PDF for accessibility purposes.
Throws
| PDFNetException |
|---|
public String getTemplateLeftDelimiter ()
Gets the value TemplateLeftDelimiter from the options object. Left delimiter for template tags. Defaults to '{{'.
Returns
- Left delimiter for template tags. Defaults to '{{'.
Throws
| PDFNetException |
|---|
public String getTemplateParamsJson ()
Gets the value TemplateParamsJson from the options object. JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate.
Returns
- JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate.
Throws
| PDFNetException |
|---|
public String getTemplateRightDelimiter ()
Gets the value TemplateRightDelimiter from the options object. Right delimiter for template tags. Defaults to '}}'.
Returns
- Right delimiter for template tags. Defaults to '}}'.
Throws
| PDFNetException |
|---|
public boolean getTemplateStrictMode ()
Gets the value TemplateStrictMode from the options object. If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content.
Returns
- If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content.
Throws
| PDFNetException |
|---|
public boolean getUpdateTableOfContents ()
Gets the value UpdateTableOfContents from the options object. Updates the table of contents in the document so it matches the actual locations of headings/bookmarks. By default, the table of contents is not updated. Enabling this option may negatively affect conversion speed.
Returns
- Updates the table of contents in the document so it matches the actual locations of headings/bookmarks. By default, the table of contents is not updated. Enabling this option may negatively affect conversion speed.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setApplyPageBreaksToSheet (boolean value)
Sets the value for ApplyPageBreaksToSheet in the options object. Whether we should split Excel worksheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large
Parameters
| value | Whether we should split Excel worksheets into pages so that the output resembles print output. If set to false (the default), Excel sheets will be placed one per page, except in the case where the sheets are very large |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setDisplayChangeTracking (boolean value)
Sets the value for DisplayChangeTracking in the options object. If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true.
Parameters
| value | If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). Otherwise displays the resolved document content, with no markup. Defaults to true. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setDisplayComments (OfficeToPDFOptions.DisplayComments value)
Sets the value for DisplayComments in the options object. Specifies the display of comments that are present in the document. By default, comments will not be displayed.
Parameters
| value | Specifies the display of comments that are present in the document. By default, comments will not be displayed. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setDisplayHiddenText (boolean value)
Sets the value for DisplayHiddenText in the options object. Display any hidden text that is present in the document (i.e., text that has been marked as 'Hidden' in the font style). By default, hidden text will not be displayed.
Parameters
| value | Display any hidden text that is present in the document (i.e., text that has been marked as 'Hidden' in the font style). By default, hidden text will not be displayed. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setExcelDefaultCellBorderWidth (double value)
Sets the value for ExcelDefaultCellBorderWidth in the options object. Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel.
Parameters
| value | Cell border width for table cells that would normally be drawn with no border. In units of points. Can be used to achieve a similar effect to the "show gridlines" display option within Microsoft Excel. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setExcelMaxAllowedCellCount (int value)
Sets the value for ExcelMaxAllowedCellCount in the options object. Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells.
Parameters
| value | Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. Used for early termination of resource intensive conversions. Setting this value to 250000 will allow the vast majority of Excel documents to convert without issue, while keeping RAM usage to a reasonable level. By default there is no limit to the number of allowed cells. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setHideTotalNumberOfPages (boolean value)
Sets the value for HideTotalNumberOfPages in the options object. If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document.
Parameters
| value | If the document has an element that displays the total number of pages and the total number of pages is unknown beforehand, remove those elements from the document. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setIncludeBookmarks (boolean value)
Sets the value for IncludeBookmarks in the options object. When this option is set to false, Word document bookmarks will not be converted into PDF bookmarks. However, Word headings will still be automatically converted into PDF bookmarks. By default, both Word bookmarks and headings are converted into PDF bookmarks, providing a comprehensive navigation structure within the converted PDF.
Parameters
| value | When this option is set to false, Word document bookmarks will not be converted into PDF bookmarks. However, Word headings will still be automatically converted into PDF bookmarks. By default, both Word bookmarks and headings are converted into PDF bookmarks, providing a comprehensive navigation structure within the converted PDF. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setIncrementalSave (boolean value)
Sets the value for IncrementalSave in the options object. If this option is true, the document will be saved incrementally during the conversion, thus reducing the peak memory usage. Save an empty PDFDoc to the target location before the conversion so the incremental saving is done directly to the target location. Otherwise, a temporary file will be used. PDFDoc.Save still has to be called after the conversion is done to finalize the file. Doing PDFDoc.Save with e_incremental flag will reduce the saving time but increase the PDF file size.
Parameters
| value | If this option is true, the document will be saved incrementally during the conversion, thus reducing the peak memory usage. Save an empty PDFDoc to the target location before the conversion so the incremental saving is done directly to the target location. Otherwise, a temporary file will be used. PDFDoc.Save still has to be called after the conversion is done to finalize the file. Doing PDFDoc.Save with e_incremental flag will reduce the saving time but increase the PDF file size. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setLayoutResourcesPluginPath (String value)
Sets the value for LayoutResourcesPluginPath in the options object. The path at which the pdftron-provided font resource plugin resides
Parameters
| value | The path at which the pdftron-provided font resource plugin resides |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setLocale (String value)
Sets the value for Locale in the options object. ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.
Parameters
| value | ISO 639-1 code of the locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setPassword (String value)
Sets the value for Password in the options object. Password used to decrypt password-protected office documents.
Parameters
| value | Password used to decrypt password-protected office documents. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setResourceDocPath (String value)
Sets the value for ResourceDocPath in the options object. The path at which a .docx resource document resides
Parameters
| value | The path at which a .docx resource document resides |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setSmartSubstitutionPluginPath (String value)
Sets the value for SmartSubstitutionPluginPath in the options object. The path at which the pdftron-provided font resource plugin resides
Parameters
| value | The path at which the pdftron-provided font resource plugin resides |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setStructureTagLevel (OfficeToPDFOptions.StructureTagLevel value)
Sets the value for StructureTagLevel in the options object. Specifies the level of document structure tags to include in the PDF for accessibility purposes.
Parameters
| value | Specifies the level of document structure tags to include in the PDF for accessibility purposes. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setTemplateLeftDelimiter (String value)
Sets the value for TemplateLeftDelimiter in the options object. Left delimiter for template tags. Defaults to '{{'.
Parameters
| value | Left delimiter for template tags. Defaults to '{{'. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setTemplateParamsJson (String value)
Sets the value for TemplateParamsJson in the options object. JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate.
Parameters
| value | JSON string representing the data to be merged into a PDFTron office template. For a more featureful template API, see CreateOfficeTemplate. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setTemplateRightDelimiter (String value)
Sets the value for TemplateRightDelimiter in the options object. Right delimiter for template tags. Defaults to '}}'.
Parameters
| value | Right delimiter for template tags. Defaults to '}}'. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setTemplateStrictMode (boolean value)
Sets the value for TemplateStrictMode in the options object. If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content.
Parameters
| value | If "Strict Mode" is enabled, when a template key is missing from the json data an exception will be thrown. If "Strict Mode" is disabled (default), the tag will be replaced with no content. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setUpdateTableOfContents (boolean value)
Sets the value for UpdateTableOfContents in the options object. Updates the table of contents in the document so it matches the actual locations of headings/bookmarks. By default, the table of contents is not updated. Enabling this option may negatively affect conversion speed.
Parameters
| value | Updates the table of contents in the document so it matches the actual locations of headings/bookmarks. By default, the table of contents is not updated. Enabling this option may negatively affect conversion speed. |
|---|
Returns
- This object, for call chaining.
Throws
| PDFNetException |
|---|