Apryse WebViewer Class: OfficeToPDFOptions

Class: OfficeToPDFOptions

Core .PDFNet .Convert. OfficeToPDFOptions

new OfficeToPDFOptions(json)

An object containing options for wordToPdf functions.

Parameters:

Name	Type	Description
`json`	string	JSON data containing options values for OfficeToPDFOptions.

Members

<static> AnimationMode

PowerPoint document animation display options.

Properties:

Name	Type	Description
`e_ignore`	number	Default value. Displays the default (preview) slide layout and ignores any animations. The number of generated pages is equal to the number of slides.
`e_paginate`	number	Follows PowerPoint's presentation mode where each click through the presentation will be generated as a new page. If a slide contains animations that show or hide content, each click through that slide is a new page.

<static> DisplayComments

Word document comment options.

Properties:

Name	Type	Description
`e_off`	number	Default value. Display no comments.
`e_annotations`	number	Display comments as annotations.

<static> DisplaySpeakerNotes

PowerPoint document speaker note options.

Properties:

Name	Type	Description
`e_no_speaker_notes`	number	Default value. Display no speaker notes.
`e_speaker_notes_annotations`	number	Display speaker notes as annotations.

<static> StructureTagLevel

Level of detail for structure tags.

Properties:

Name	Type	Description
`e_default`	number	Default level of structure tags, good for accessibility.
`e_none`	number	No structure tags. This can be used to get smaller file sizes.

<static> UpdateDynamicFields

Dynamic fields to be updated within the document. Enum values can be bitwise OR-ed to define a specific combination of fields to be updated.

Properties:

Name	Type	Description
`e_update_all`	number	Updates all dynamic fields within the document.
`e_update_none`	number	Default value. Does not update dynamic fields within the document.
`e_update_doc_props`	number	Updates document property fields within the document.

Methods

getAnimationHandling()

Gets the value AnimationHandling from the options object. Specifies the handling of animations present in the PowerPoint document. By default, animations will be ignored and only the default content of each slide will be displayed.

Returns:

The current value for AnimationHandling.

Type: number

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:

The current value for ApplyPageBreaksToSheet.

Type: boolean

getDisableExcelHeadersFooters()

Gets the value DisableExcelHeadersFooters from the options object. Disables the conversion of Excel headers and footers. When this flag is set to True, any headers or footers in the original Excel sheet will be ignored in the output.

Returns:

The current value for DisableExcelHeadersFooters.

Type: boolean

getDisableExcelMargins()

Gets the value DisableExcelMargins from the options object. Sets Excel page margins to zero. When this flag is set to True, the output pages of the Excel conversion will have no margins.

Returns:

The current value for DisableExcelMargins.

Type: boolean

getDisableSheetHeightLimit()

Gets the value DisableSheetHeightLimit from the options object. Removes the default sheet height limit of 12 feet, after which the sheet would be divided into pages up to 4 feet long each. When this flag is set to True and ApplyPageBreaksToSheet is set to False, each page will contain the entire corresponding sheet.

Returns:

The current value for DisableSheetHeightLimit.

Type: 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:

The current value for DisplayChangeTracking.

Type: boolean

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:

The current value for DisplayComments.

Type: number

Example

Return value:
<pre>
PDFNet.Convert.OfficeToPDFOptions.DisplayComments = {
 e_off : 0
 e_annotations : 1
}
</pre>

getDisplayHiddenCells()

Gets the value DisplayHiddenCells from the options object. Display any hidden rows and columns present in the Excel sheet (i.e., rows/columns with visibility set as 'hidden'). By default, hidden cells will not be displayed.

Returns:

The current value for DisplayHiddenCells.

Type: 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:

The current value for DisplayHiddenText.

Type: boolean

getDisplaySpeakerNotes()

Gets the value DisplaySpeakerNotes from the options object. Specifies the display of speaker notes that are present in the PowerPoint document. By default, speaker notes will not be displayed.

Returns:

The current value for DisplaySpeakerNotes.

Type: number

Example

Return value:
<pre>
PDFNet.Convert.OfficeToPDFOptions.DisplaySpeakerNotes = {
 e_no_speaker_notes : 0
 e_speaker_notes_annotations : 1
}
</pre>

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:

The current value for ExcelDefaultCellBorderWidth.

Type: number

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:

The current value for ExcelMaxAllowedCellCount.

Type: number

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:

The current value for HideTotalNumberOfPages.

Type: 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:

The current value for IncludeBookmarks.

Type: 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:

The current value for IncrementalSave.

Type: boolean

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:

The current value for Locale.

Type: string

getPassword()

Gets the value Password from the options object. Password used to decrypt password-protected office documents.

Returns:

The current value for Password.

Type: string

getShowExcelGridlines()

Gets the value ShowExcelGridlines from the options object. Forces Excel gridlines to appear in the output when they are not enabled in the original sheet.

Returns:

The current value for ShowExcelGridlines.

Type: boolean

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:

The current value for StructureTagLevel.

Type: number

Example

Return value:
<pre>
PDFNet.Convert.OfficeToPDFOptions.StructureTagLevel = {
 e_default : 0
 e_none : 1
}
</pre>

getTemplateLeftDelimiter()

Gets the value TemplateLeftDelimiter from the options object. Left delimiter for template tags. Defaults to '{{'.

Returns:

The current value for TemplateLeftDelimiter.

Type: 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:

The current value for TemplateParamsJson.

Type: string

getTemplateRightDelimiter()

Gets the value TemplateRightDelimiter from the options object. Right delimiter for template tags. Defaults to '}}'.

Returns:

The current value for TemplateRightDelimiter.

Type: string

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:

The current value for TemplateStrictMode.

Type: boolean

getUpdateDynamicFields()

Gets the value UpdateDynamicFields from the options object. Specifies which dynamic fields should be updated within the document. By default, dynamic fields will display cached field values, which is consistent with the PDF export behaviour of Word. This option allows fine-tuning which types of dynamic fields are updated, which would otherwise have to be done manually in Word. Updating dynamic fields can improve the accuracy of field content, though it may increase conversion time. Some dynamic fields such as page numbers are always updated regardless of this setting.

Returns:

The current value for UpdateDynamicFields.

Type: number

Example

Return value:
<pre>
PDFNet.Convert.OfficeToPDFOptions.UpdateDynamicFields = {
 e_update_all : -1
 e_update_none : 0
 e_update_doc_props : 1
}
</pre>

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:

The current value for UpdateTableOfContents.

Type: boolean

setAnimationHandling(value)

Sets the value for AnimationHandling in the options object. Specifies the handling of animations present in the PowerPoint document. By default, animations will be ignored and only the default content of each slide will be displayed.

Parameters:

Name	Type	Description
`value`	number	The new value for AnimationHandling

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setApplyPageBreaksToSheet(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:

Name	Type	Description
`value`	boolean	The new value for ApplyPageBreaksToSheet

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setDisableExcelHeadersFooters(value)

Sets the value for DisableExcelHeadersFooters in the options object. Disables the conversion of Excel headers and footers. When this flag is set to True, any headers or footers in the original Excel sheet will be ignored in the output.

Parameters:

Name	Type	Description
`value`	boolean	The new value for DisableExcelHeadersFooters

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setDisableExcelMargins(value)

Sets the value for DisableExcelMargins in the options object. Sets Excel page margins to zero. When this flag is set to True, the output pages of the Excel conversion will have no margins.

Parameters:

Name	Type	Description
`value`	boolean	The new value for DisableExcelMargins

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setDisableSheetHeightLimit(value)

Sets the value for DisableSheetHeightLimit in the options object. Removes the default sheet height limit of 12 feet, after which the sheet would be divided into pages up to 4 feet long each. When this flag is set to True and ApplyPageBreaksToSheet is set to False, each page will contain the entire corresponding sheet.

Parameters:

Name	Type	Description
`value`	boolean	The new value for DisableSheetHeightLimit

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

setDisplayComments(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:

Name	Type	Description
`value`	number	The new value for DisplayComments PDFNet.Convert.OfficeToPDFOptions.DisplayComments = { e_off : 0 e_annotations : 1 }

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setDisplayHiddenCells(value)

Sets the value for DisplayHiddenCells in the options object. Display any hidden rows and columns present in the Excel sheet (i.e., rows/columns with visibility set as 'hidden'). By default, hidden cells will not be displayed.

Parameters:

Name	Type	Description
`value`	boolean	The new value for DisplayHiddenCells

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setDisplayHiddenText(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:

Name	Type	Description
`value`	boolean	The new value for DisplayHiddenText

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setDisplaySpeakerNotes(value)

Sets the value for DisplaySpeakerNotes in the options object. Specifies the display of speaker notes that are present in the PowerPoint document. By default, speaker notes will not be displayed.

Parameters:

Name	Type	Description
`value`	number	The new value for DisplaySpeakerNotes PDFNet.Convert.OfficeToPDFOptions.DisplaySpeakerNotes = { e_no_speaker_notes : 0 e_speaker_notes_annotations : 1 }

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setExcelDefaultCellBorderWidth(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:

Name	Type	Description
`value`	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

setHideTotalNumberOfPages(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:

Name	Type	Description
`value`	boolean	The new value for HideTotalNumberOfPages

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setIncludeBookmarks(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:

Name	Type	Description
`value`	boolean	The new value for IncludeBookmarks

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setIncrementalSave(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:

Name	Type	Description
`value`	boolean	The new value for IncrementalSave

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 locale to be applied during conversion. For example: 'en-US', 'ar-SA', 'de-DE', etc. Currently only applied during xls/xlsx conversions.

Parameters:

Name	Type	Description
`value`	string	The new value for Locale

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setPassword(value)

Sets the value for Password in the options object. Password used to decrypt password-protected office documents.

Parameters:

Name	Type	Description
`value`	string	The new value for Password

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setShowExcelGridlines(value)

Sets the value for ShowExcelGridlines in the options object. Forces Excel gridlines to appear in the output when they are not enabled in the original sheet.

Parameters:

Name	Type	Description
`value`	boolean	The new value for ShowExcelGridlines

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setStructureTagLevel(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:

Name	Type	Description
`value`	number	The new value for StructureTagLevel PDFNet.Convert.OfficeToPDFOptions.StructureTagLevel = { e_default : 0 e_none : 1 }

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setTemplateLeftDelimiter(value)

Sets the value for TemplateLeftDelimiter in the options object. Left delimiter for template tags. Defaults to '{{'.

Parameters:

Name	Type	Description
`value`	string	The new value for TemplateLeftDelimiter

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. For a more featureful template API, see CreateOfficeTemplate.

Parameters:

Name	Type	Description
`value`	string	The new value for TemplateParamsJson

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setTemplateRightDelimiter(value)

Sets the value for TemplateRightDelimiter in the options object. Right delimiter for template tags. Defaults to '}}'.

Parameters:

Name	Type	Description
`value`	string	The new value for TemplateRightDelimiter

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setTemplateStrictMode(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:

Name	Type	Description
`value`	boolean	The new value for TemplateStrictMode

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setUpdateDynamicFields(value)

Sets the value for UpdateDynamicFields in the options object. Specifies which dynamic fields should be updated within the document. By default, dynamic fields will display cached field values, which is consistent with the PDF export behaviour of Word. This option allows fine-tuning which types of dynamic fields are updated, which would otherwise have to be done manually in Word. Updating dynamic fields can improve the accuracy of field content, though it may increase conversion time. Some dynamic fields such as page numbers are always updated regardless of this setting.

Parameters:

Name	Type	Description
`value`	number	The new value for UpdateDynamicFields PDFNet.Convert.OfficeToPDFOptions.UpdateDynamicFields = { e_update_all : -1 e_update_none : 0 e_update_doc_props : 1 }

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions

setUpdateTableOfContents(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:

Name	Type	Description
`value`	boolean	The new value for UpdateTableOfContents

Returns:

This object, for call chaining.

Type: PDFNet.Convert.OfficeToPDFOptions