All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::PDF::OfficeToPDFOptions Class Reference

#include <OfficeToPDFOptions.h>

+ Inheritance diagram for pdftron::PDF::OfficeToPDFOptions:

Public Member Functions

 OfficeToPDFOptions ()
 
 ~OfficeToPDFOptions ()
 
bool GetApplyPageBreaksToSheet ()
 
OfficeToPDFOptionsSetApplyPageBreaksToSheet (bool value)
 
bool GetDisplayChangeTracking ()
 
OfficeToPDFOptionsSetDisplayChangeTracking (bool value)
 
double GetExcelDefaultCellBorderWidth ()
 
OfficeToPDFOptionsSetExcelDefaultCellBorderWidth (double value)
 
UInt32 GetExcelMaxAllowedCellCount ()
 
OfficeToPDFOptionsSetExcelMaxAllowedCellCount (UInt32 value)
 
UString GetLayoutResourcesPluginPath ()
 
OfficeToPDFOptionsSetLayoutResourcesPluginPath (UString value)
 
UString GetLocale ()
 
OfficeToPDFOptionsSetLocale (UString value)
 
UString GetResourceDocPath ()
 
OfficeToPDFOptionsSetResourceDocPath (UString value)
 
UString GetSmartSubstitutionPluginPath ()
 
OfficeToPDFOptionsSetSmartSubstitutionPluginPath (UString value)
 
UString GetTemplateParamsJson ()
 
OfficeToPDFOptionsSetTemplateParamsJson (UString value)
 

Detailed Description

Definition at line 9 of file OfficeToPDFOptions.h.

Constructor & Destructor Documentation

pdftron::PDF::OfficeToPDFOptions::OfficeToPDFOptions ( )
pdftron::PDF::OfficeToPDFOptions::~OfficeToPDFOptions ( )

Member Function Documentation

bool pdftron::PDF::OfficeToPDFOptions::GetApplyPageBreaksToSheet ( )

Gets the value ApplyPageBreaksToSheet from the options object Whether we should split Excel workheets into pages so that the output resembles print output. @ return a bool, the current value for ApplyPageBreaksToSheet.

bool pdftron::PDF::OfficeToPDFOptions::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. @ return a bool, the current value for DisplayChangeTracking.

double pdftron::PDF::OfficeToPDFOptions::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. @ return a double, the current value for ExcelDefaultCellBorderWidth.

UInt32 pdftron::PDF::OfficeToPDFOptions::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. @ return a UInt32, the current value for ExcelMaxAllowedCellCount.

UString pdftron::PDF::OfficeToPDFOptions::GetLayoutResourcesPluginPath ( )

Gets the value LayoutResourcesPluginPath from the options object The path at which the pdftron-provided font resource plugin resides @ return a UString, the current value for LayoutResourcesPluginPath.

UString pdftron::PDF::OfficeToPDFOptions::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. @ return a UString, the current value for Locale.

UString pdftron::PDF::OfficeToPDFOptions::GetResourceDocPath ( )

Gets the value ResourceDocPath from the options object The path at which a .docx resource document resides @ return a UString, the current value for ResourceDocPath.

UString pdftron::PDF::OfficeToPDFOptions::GetSmartSubstitutionPluginPath ( )

Gets the value SmartSubstitutionPluginPath from the options object The path at which the pdftron-provided font resource plugin resides @ return a UString, the current value for SmartSubstitutionPluginPath.

UString pdftron::PDF::OfficeToPDFOptions::GetTemplateParamsJson ( )

Gets the value TemplateParamsJson from the options object JSON string representing the data to be merged into a PDFTron office template @ return a UString, the current value for TemplateParamsJson.

OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetApplyPageBreaksToSheet ( bool  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
value,:the new value for ApplyPageBreaksToSheet
Returns
this object, for call chaining
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetDisplayChangeTracking ( bool  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
OfficeToPDFOptions& pdftron::PDF::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
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetExcelMaxAllowedCellCount ( UInt32  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
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetLayoutResourcesPluginPath ( UString  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
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetLocale ( UString  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
value,:the new value for Locale
Returns
this object, for call chaining
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetResourceDocPath ( UString  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
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetSmartSubstitutionPluginPath ( UString  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
OfficeToPDFOptions& pdftron::PDF::OfficeToPDFOptions::SetTemplateParamsJson ( UString  value)

Sets the value for TemplateParamsJson in the options object JSON string representing the data to be merged into a PDFTron office template

Parameters
value,:the new value for TemplateParamsJson
Returns
this object, for call chaining

The documentation for this class was generated from the following file: