Foxit PDF SDK
fsdk.Excel2PDFSettingData Class Reference

Public Member Functions

def GetConvert_to_pdfa ()
 Get (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. More...
 
def GetDisable_vba_code ()
 Get a boolean value decide whether to disable the execution of vba code in the Excel document. More...
 
def GetIgnore_print_area ()
 Get a boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file. More...
 
def GetInclude_doc_props ()
 Get a boolean value which indicates whether to include Excel document properties in the converted PDF document. More...
 
def GetQuality ()
 Get quality for covnerting Excel to PDF. More...
 
def GetScale_type ()
 Get scale type for the Excel sheet when converting Excel document to PDF file. More...
 
def Set (include_doc_props, quality, ignore_print_area, scale_type, convert_to_pdfa)
 Set value. More...
 
def SetConvert_to_pdfa (value)
 Set (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. More...
 
def SetDisable_vba_code (value)
 Set a boolean value decide whether to disable the execution of vba code in the Excel document. More...
 
def SetIgnore_print_area (value)
 Set a boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file. More...
 
def SetInclude_doc_props (value)
 Set a boolean value which indicates whether to include Excel document properties in the converted PDF document. More...
 
def SetQuality (value)
 Set quality for covnerting Excel to PDF. More...
 
def SetScale_type (value)
 Set scale type for the Excel sheet when converting Excel document to PDF file. More...
 

Detailed Description

This class represents setting data used for converting Excel to PDF.

Member Function Documentation

◆ GetConvert_to_pdfa()

fsdk.Excel2PDFSettingData.GetConvert_to_pdfa ( )

Get (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file.

true means to convert Excel document to a PDF/A file.
false means to convert Excel document to a common file.

Returns
(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false.

◆ GetDisable_vba_code()

fsdk.Excel2PDFSettingData.GetDisable_vba_code ( )

Get a boolean value decide whether to disable the execution of vba code in the Excel document.

true means to disable the vba code, while false means not. Default value:false.
This flag is only supported on Windows platforms.

Returns
A boolean value decide whether to disable the execution of vba code in the Excel document.

◆ GetIgnore_print_area()

fsdk.Excel2PDFSettingData.GetIgnore_print_area ( )

Get a boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file.

true means to ignore any setting of print area in Excel document.
false means to use the setting of print areas in Excel document.

Returns
A boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file.

◆ GetInclude_doc_props()

fsdk.Excel2PDFSettingData.GetInclude_doc_props ( )

Get a boolean value which indicates whether to include Excel document properties in the converted PDF document.

true means to include Excel document properties in the converted PDF document.
false means not to include Excel document properties in the converted PDF document.

Returns
A boolean value which indicates whether to include Excel document properties in the converted PDF document.

◆ GetQuality()

fsdk.Excel2PDFSettingData.GetQuality ( )

Get quality for covnerting Excel to PDF.

Returns
Quality for covnerting Excel to PDF. Please refer to values starting from fsdk.Excel2PDFSettingDataE_ConvertQualityStandard and this should be one of these values.

◆ GetScale_type()

fsdk.Excel2PDFSettingData.GetScale_type ( )

Get scale type for the Excel sheet when converting Excel document to PDF file.

Returns
Scale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from fsdk.Excel2PDFSettingDataE_ScaleTypeNone and this should be one of these values.

◆ Set()

def fsdk.Excel2PDFSettingData.Set (   include_doc_props,
  quality,
  ignore_print_area,
  scale_type,
  convert_to_pdfa 
)

Set value.

Parameters
[in]include_doc_propsA boolean value which indicates whether to include Excel document properties in the converted PDF document.
[in]qualityQuality for covnerting Excel to PDF. Please refer to values starting from fsdk.Excel2PDFSettingDataE_ConvertQualityStandard and this should be one of these values.
[in]ignore_print_areaA boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file.
[in]scale_typeScale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from fsdk.Excel2PDFSettingDataE_ScaleTypeNone and this should be one of these values.
[in]convert_to_pdfa(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false.
Returns
None.

◆ SetConvert_to_pdfa()

fsdk.Excel2PDFSettingData.SetConvert_to_pdfa (   value)

Set (Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file.

true means to convert Excel document to a PDF/A file.
false means to convert Excel document to a common file.

Parameters
[in]value(Reserved) A boolean value which indicates whether to convert to a PDF/A file or a common PDF file. Currently, this is useless and Foxit PDF SDK will treated as false.
Returns
None.

◆ SetDisable_vba_code()

fsdk.Excel2PDFSettingData.SetDisable_vba_code (   value)

Set a boolean value decide whether to disable the execution of vba code in the Excel document.

true means to disable the vba code, while false means not. Default value:false.
This flag is only supported on Windows platforms.

Parameters
[in]valueA boolean value decide whether to disable the execution of vba code in the Excel document.
Returns
None.

◆ SetIgnore_print_area()

fsdk.Excel2PDFSettingData.SetIgnore_print_area (   value)

Set a boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file.

true means to ignore any setting of print area in Excel document.
false means to use the setting of print areas in Excel document.

Parameters
[in]valueA boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file.
Returns
None.

◆ SetInclude_doc_props()

fsdk.Excel2PDFSettingData.SetInclude_doc_props (   value)

Set a boolean value which indicates whether to include Excel document properties in the converted PDF document.

true means to include Excel document properties in the converted PDF document.
false means not to include Excel document properties in the converted PDF document.

Parameters
[in]valueA boolean value which indicates whether to include Excel document properties in the converted PDF document.
Returns
None.

◆ SetQuality()

fsdk.Excel2PDFSettingData.SetQuality (   value)

Set quality for covnerting Excel to PDF.

Parameters
[in]valueQuality for covnerting Excel to PDF. Please refer to values starting from fsdk.Excel2PDFSettingDataE_ConvertQualityStandard and this should be one of these values.
Returns
None.

◆ SetScale_type()

fsdk.Excel2PDFSettingData.SetScale_type (   value)

Set scale type for the Excel sheet when converting Excel document to PDF file.

Parameters
[in]valueScale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from fsdk.Excel2PDFSettingDataE_ScaleTypeNone and this should be one of these values.
Returns
None.