| java.lang.Object | |||
| ↳ | com.pdftron.pdf.OptionsBase | ||
| ↳ | com.pdftron.pdf.ConversionOptions | ||
| ↳ | com.pdftron.pdf.OfficeToPDFOptions | ||
Summary
| 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).
| ||||||||||
| 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.
| ||||||||||
| 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 current system locale.
| ||||||||||
| 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
| ||||||||||
| String |
getTemplateParamsJson()
Gets the value TemplateParamsJson from the options object
JSON string representing the data to be merged into a PDFTron office template
| ||||||||||
| 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 |
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 |
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 current system locale.
| ||||||||||
| 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 |
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
| ||||||||||
|
[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.
Returns
- a boolean, Whether we should split Excel workheets into pages so that the output resembles print output..
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 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
- an int -- max allowed cell count
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 current system locale. For example: 'en-US', 'ar-SA', 'de-DE', etc.
Returns
- a String, ISO 639-1 code of the current system locale. For example: 'en-US', 'ar-SA', 'de-DE', etc..
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 String getTemplateParamsJson ()
Gets the value TemplateParamsJson from the options object JSON string representing the data to be merged into a PDFTron office template
Returns
- a String, JSON string representing the data to be merged into a PDFTron office template.
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.
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 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 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 current system locale. For example: 'en-US', 'ar-SA', 'de-DE', etc.
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 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
Returns
- this object, for call chaining
Throws
| PDFNetException |
|---|