Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]
public class

# OfficeToPDFOptions

extends ConversionOptions

java.lang.Object
↳ | com.pdftron.pdf.OptionsBase
| ↳ | com.pdftron.pdf.ConversionOptions
|  | ↳ | com.pdftron.pdf.OfficeToPDFOptions

## Summary

Nested Classes
enum | OfficeToPDFOptions.AnimationMode | PowerPoint document animation display options.
enum | OfficeToPDFOptions.DisplayComments | Word document comment options.
enum | OfficeToPDFOptions.DisplaySpeakerNotes | PowerPoint document speaker note options.
enum | OfficeToPDFOptions.StructureTagLevel | Level of detail for structure tags.
class | OfficeToPDFOptions.UpdateDynamicFields | Dynamic fields to be updated within the document.

Public Constructors
| OfficeToPDFOptions() Constructor.
| OfficeToPDFOptions(String json_string) Constructor.

Public Methods
OfficeToPDFOptions.AnimationMode | getAnimationHandling() Gets the value AnimationHandling from the options object.
boolean | getApplyPageBreaksToSheet() Gets the value ApplyPageBreaksToSheet from the options object.
boolean | getDisableExcelHeadersFooters() Gets the value DisableExcelHeadersFooters from the options object.
boolean | getDisableExcelMargins() Gets the value DisableExcelMargins from the options object.
boolean | getDisableSheetHeightLimit() Gets the value DisableSheetHeightLimit 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 | getDisplayHiddenCells() Gets the value DisplayHiddenCells from the options object.
boolean | getDisplayHiddenText() Gets the value DisplayHiddenText from the options object.
OfficeToPDFOptions.DisplaySpeakerNotes | getDisplaySpeakerNotes() Gets the value DisplaySpeakerNotes 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.
boolean | getShowExcelGridlines() Gets the value ShowExcelGridlines 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.
int | getUpdateDynamicFields() Gets the value UpdateDynamicFields from the options object.
boolean | getUpdateTableOfContents() Gets the value UpdateTableOfContents from the options object.
OfficeToPDFOptions | setAnimationHandling(OfficeToPDFOptions.AnimationMode value) Sets the value for AnimationHandling in the options object.
OfficeToPDFOptions | setApplyPageBreaksToSheet(boolean value) Sets the value for ApplyPageBreaksToSheet in the options object.
OfficeToPDFOptions | setDisableExcelHeadersFooters(boolean value) Sets the value for DisableExcelHeadersFooters in the options object.
OfficeToPDFOptions | setDisableExcelMargins(boolean value) Sets the value for DisableExcelMargins in the options object.
OfficeToPDFOptions | setDisableSheetHeightLimit(boolean value) Sets the value for DisableSheetHeightLimit 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 | setDisplayHiddenCells(boolean value) Sets the value for DisplayHiddenCells in the options object.
OfficeToPDFOptions | setDisplayHiddenText(boolean value) Sets the value for DisplayHiddenText in the options object.
OfficeToPDFOptions | setDisplaySpeakerNotes(OfficeToPDFOptions.DisplaySpeakerNotes value) Sets the value for DisplaySpeakerNotes 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 | setShowExcelGridlines(boolean value) Sets the value for ShowExcelGridlines 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 | setUpdateDynamicFields(int value) Sets the value for UpdateDynamicFields 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
boolean | getEnableExternalMediaDownloads() Gets the value of EnableExternalMediaDownloads from the options object used to determine if downloading external resources is allowed during conversion.
String | getFileExtension() Gets the value of FileExtension from the options object Override file extension used to determine conversion type.
ConversionOptions | setEnableExternalMediaDownloads(boolean value) Sets the value for EnableExternalMediaDownloads in the options object used to determine if downloading external resources is allowed during conversion.
ConversionOptions | setFileExtension(String value) Sets the value for FileExtension in the options object Override file extension used to determine conversion type.
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public OfficeToPDFOptions ()

Constructor.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions (String json_string)

Constructor.

##### Throws

PDFNetException |

## Public Methods

#### public OfficeToPDFOptions.AnimationMode 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.

##### Throws

PDFNetException |

#### 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

- The current value for ApplyPageBreaksToSheet.

##### Throws

PDFNetException |

#### public 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.

##### Throws

PDFNetException |

#### public 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.

##### Throws

PDFNetException |

#### public 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.

##### 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

- The current value for DisplayChangeTracking.

##### 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

- The current value for DisplayComments.

##### Throws

PDFNetException |

#### public boolean 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.

##### 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

- The current value for DisplayHiddenText.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions.DisplaySpeakerNotes 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.

##### 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

- The current value for ExcelDefaultCellBorderWidth.

##### 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

- The current value for ExcelMaxAllowedCellCount.

##### 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

- The current value for HideTotalNumberOfPages.

##### 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

- The current value for IncludeBookmarks.

##### 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

- The current value for IncrementalSave.

##### 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 current value for LayoutResourcesPluginPath.

##### 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

- The current value for Locale.

##### Throws

PDFNetException |

#### public String getPassword ()

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

##### Returns

- The current value for Password.

##### Throws

PDFNetException |

#### public String getResourceDocPath ()

Gets the value ResourceDocPath from the options object. The path at which a .docx resource document resides.

##### Returns

- The current value for ResourceDocPath.

##### Throws

PDFNetException |

#### public boolean 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.

##### 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 current value for SmartSubstitutionPluginPath.

##### 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

- The current value for StructureTagLevel.

##### Throws

PDFNetException |

#### public String getTemplateLeftDelimiter ()

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

##### Returns

- The current value for TemplateLeftDelimiter.

##### 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

- The current value for TemplateParamsJson.

##### Throws

PDFNetException |

#### public String getTemplateRightDelimiter ()

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

##### Returns

- The current value for TemplateRightDelimiter.

##### 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

- The current value for TemplateStrictMode.

##### Throws

PDFNetException |

#### public int 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.

##### 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

- The current value for UpdateTableOfContents.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setAnimationHandling (OfficeToPDFOptions.AnimationMode 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

value | The new value for AnimationHandling.

##### Returns

- This object, for call chaining.

##### 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 | The new value for ApplyPageBreaksToSheet.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setDisableExcelHeadersFooters (boolean 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

value | The new value for DisableExcelHeadersFooters.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setDisableExcelMargins (boolean 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

value | The new value for DisableExcelMargins.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setDisableSheetHeightLimit (boolean 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

value | The new value for DisableSheetHeightLimit.

##### 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 | The new value for DisplayChangeTracking.

##### 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 | The new value for DisplayComments.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setDisplayHiddenCells (boolean 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

value | The new value for DisplayHiddenCells.

##### 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 | The new value for DisplayHiddenText.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setDisplaySpeakerNotes (OfficeToPDFOptions.DisplaySpeakerNotes 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

value | The new value for DisplaySpeakerNotes.

##### 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 | The new value for ExcelDefaultCellBorderWidth.

##### 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 | The new value for ExcelMaxAllowedCellCount.

##### 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 | The new value for HideTotalNumberOfPages.

##### 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 | The new value for IncludeBookmarks.

##### 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 | The new value for IncrementalSave.

##### 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 new value for LayoutResourcesPluginPath.

##### 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 | The new value for Locale.

##### 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 | The new value for Password.

##### 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 new value for ResourceDocPath.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setShowExcelGridlines (boolean 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

value | The new value for ShowExcelGridlines.

##### 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 new value for SmartSubstitutionPluginPath.

##### 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 | The new value for StructureTagLevel.

##### 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 | The new value for TemplateLeftDelimiter.

##### 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 | The new value for TemplateParamsJson.

##### 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 | The new value for TemplateRightDelimiter.

##### 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 | The new value for TemplateStrictMode.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public OfficeToPDFOptions setUpdateDynamicFields (int 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

value | The new value for UpdateDynamicFields.

##### 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 | The new value for UpdateTableOfContents.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |