| java.lang.Object | |||
| ↳ | com.pdftron.pdf.OptionsBase | ||
| ↳ | com.pdftron.pdf.ConversionOptions | ||
| ↳ | com.pdftron.pdf.OfficeToPDFOptions | ||
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| 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
Whether we should split Excel workheets into pages so that the output resembles print output.
| ||||||||||
| 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).
| ||||||||||
| 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).
| ||||||||||
| double |
getExcelDefaultCellBorderWidth()
Gets the value ExcelDefaultCellBorderWidth from the options object
Cell border width for table cells that would normally be drawn with no border.
| ||||||||||
| 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.
| ||||||||||
| 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.
| ||||||||||
| String |
getLayoutResourcesPluginPath()
Gets the value LayoutResourcesPluginPath from the options object
The path at which the pdftron-provided font resource plugin resides
| ||||||||||
| String |
getLocale()
Gets the value Locale from the options object
ISO 639-1 code of the locale to be applied during conversion.
| ||||||||||
| String |
getPassword()
Gets the value Password from the options object
Password used to decrypt password-protected office documents.
| ||||||||||
| String |
getResourceDocPath()
Gets the value ResourceDocPath from the options object
The path at which a .docx resource document resides
| ||||||||||
| String |
getSmartSubstitutionPluginPath()
Gets the value SmartSubstitutionPluginPath from the options object
The path at which the pdftron-provided font resource plugin resides
| ||||||||||
| int |
getStructureTagLevel()
Gets the value StructureTagLevel from the options object
Specifies the level of document structure tags to include in the PDF for accessibility purposes.
| ||||||||||
| String |
getTemplateLeftDelimiter()
Gets the value TemplateLeftDelimiter from the options object
Left delimiter for template tags.
| ||||||||||
| String |
getTemplateParamsJson()
Gets the value TemplateParamsJson from the options object
JSON string representing the data to be merged into a PDFTron office template.
| ||||||||||
| String |
getTemplateRightDelimiter()
Gets the value TemplateRightDelimiter from the options object
Right delimiter for template tags.
| ||||||||||
| 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.
| ||||||||||
| 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.
| ||||||||||
| OfficeToPDFOptions |
setApplyPageBreaksToSheet(boolean value)
Sets the value for ApplyPageBreaksToSheet in the options object
Whether we should split Excel workheets into pages so that the output resembles print output.
| ||||||||||
| 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).
| ||||||||||
| 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).
| ||||||||||
| 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.
| ||||||||||
| 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.
| ||||||||||
| 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.
| ||||||||||
| OfficeToPDFOptions |
setLayoutResourcesPluginPath(String value)
Sets the value for LayoutResourcesPluginPath in the options object
The path at which the pdftron-provided font resource plugin resides
| ||||||||||
| 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.
| ||||||||||
| OfficeToPDFOptions |
setPassword(String value)
Sets the value for Password in the options object
Password used to decrypt password-protected office documents.
| ||||||||||
| OfficeToPDFOptions |
setResourceDocPath(String value)
Sets the value for ResourceDocPath in the options object
The path at which a .docx resource document resides
| ||||||||||
| OfficeToPDFOptions |
setSmartSubstitutionPluginPath(String value)
Sets the value for SmartSubstitutionPluginPath in the options object
The path at which the pdftron-provided font resource plugin resides
| ||||||||||
| OfficeToPDFOptions |
setStructureTagLevel(int 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.
| ||||||||||
| OfficeToPDFOptions |
setTemplateLeftDelimiter(String value)
Sets the value for TemplateLeftDelimiter in the options object
Left delimiter for template tags.
| ||||||||||
| 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.
| ||||||||||
| OfficeToPDFOptions |
setTemplateRightDelimiter(String value)
Sets the value for TemplateRightDelimiter in the options object
Right delimiter for template tags.
| ||||||||||
| 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.
| ||||||||||
| 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.
| ||||||||||
|
[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 workheets 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
- a boolean, Whether we should split Excel workheets 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
- a boolean, 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 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
- a boolean, 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
- a double, 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
- a int, 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
- a boolean, 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 String getLayoutResourcesPluginPath ()
Gets the value LayoutResourcesPluginPath from the options object The path at which the pdftron-provided font resource plugin resides
Returns
- a String, 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
- a String, 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
- a String, 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
- a String, 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
- a String, The path at which the pdftron-provided font resource plugin resides.
Throws
| PDFNetException |
|---|
public int 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
- a int, 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
- a String, 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
- a String, 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
- a String, 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
- a boolean, 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
- a boolean, 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 workheets 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.
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.
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.
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.
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.
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
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.
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.
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
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
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|
public OfficeToPDFOptions setStructureTagLevel (int 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.
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 '{{'.
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.
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 '}}'.
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.
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.
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|