Class: OfficeToPDFOptions

PDFNet.Convert. OfficeToPDFOptions


new OfficeToPDFOptions( [json])

An object containing options for wordToPdf functions
Parameters:
Name Type Argument Description
json string <optional>
options in JSON format.

Extends

  • ConversionOptions

Methods


setApplyPageBreaksToSheet(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.
Parameters:
Name Type Description
value boolean the new value for ApplyPageBreaksToSheet
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setDisplayChangeTracking(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:
Name Type Description
value boolean the new value for DisplayChangeTracking
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setExcelDefaultCellBorderWidth(width)

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:
Name Type Description
width number the new value for ExcelDefaultCellBorderWidth
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setExcelMaxAllowedCellCount(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:
Name Type Description
value number the new value for ExcelMaxAllowedCellCount
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setLayoutResourcesPluginPath(value)

Sets the value for LayoutResourcesPluginPath in the options object The path at which the pdftron-provided font resource plugin resides
Parameters:
Name Type Description
value string The path at which the pdftron-provided font resource plugin resides
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setLocale(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.
Parameters:
Name Type Description
value string the new value for Locale
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setResourceDocPath(value)

Sets the value for ResourceDocPath in the options object The path at which the a .docx resource document resides
Parameters:
Name Type Description
value string The path at which the a .docx resource document resides
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setSmartSubstitutionPluginPath(value)

Sets the value for SmartSubstitutionPluginPath in the options object The path at which the pdftron-provided font resource plugin resides
Parameters:
Name Type Description
value string The path at which the pdftron-provided font resource plugin resides
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions

setTemplateParamsJson(value)

Sets the value for TemplateParamsJson in the options object JSON string representing the data to be merged into a PDFTron office template
Parameters:
Name Type Description
value string the new value for TemplateParamsJson
Returns:
this object, for call chaining
Type
PDFNet.Convert.OfficeToPDFOptions