Foxit PDF SDK
FoxitPDFSDKPython3.Excel2PDFSettingData Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def Excel2PDFSettingData ()
 Constructor. More...
 
def Set (include_doc_props, quality, ignore_print_area, scale_type, convert_to_pdfa)
 Set value. More...
 

Static Public Attributes

 convert_to_pdfa = _swig_property(_fsdk.Excel2PDFSettingData_convert_to_pdfa_get, _fsdk.Excel2PDFSettingData_convert_to_pdfa_set)
 (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. More...
 
 e_ConvertQualityMinimum = _fsdk.Excel2PDFSettingData_e_ConvertQualityMinimum
 Minimum quality.
 
 e_ConvertQualityStandard = _fsdk.Excel2PDFSettingData_e_ConvertQualityStandard
 Standard quality.
 
 e_ScaleTypeFitAllColumns = _fsdk.Excel2PDFSettingData_e_ScaleTypeFitAllColumns
 Fit all columns of one sheet on one page.
 
 e_ScaleTypeFitAllRows = _fsdk.Excel2PDFSettingData_e_ScaleTypeFitAllRows
 Fit all rows of one sheet on one page.
 
 e_ScaleTypeFitSheet = _fsdk.Excel2PDFSettingData_e_ScaleTypeFitSheet
 Fit a sheet on one page.
 
 e_ScaleTypeNone = _fsdk.Excel2PDFSettingData_e_ScaleTypeNone
 No scaling.
 
 ignore_print_area = _swig_property(_fsdk.Excel2PDFSettingData_ignore_print_area_get, _fsdk.Excel2PDFSettingData_ignore_print_area_set)
 A boolean value which indicates whether to ignore any print area set when converting Excel document to PDF file. More...
 
 include_doc_props = _swig_property(_fsdk.Excel2PDFSettingData_include_doc_props_get, _fsdk.Excel2PDFSettingData_include_doc_props_set)
 A boolean value which indicates whether to include Excel document properties in the converted PDF document. More...
 
 quality = _swig_property(_fsdk.Excel2PDFSettingData_quality_get, _fsdk.Excel2PDFSettingData_quality_set)
 Quality for covnerting Excel to PDF. Please refer to values starting from FoxitPDFSDKPython3.Excel2PDFSettingData.e_ConvertQualityStandard and this should be one of these values.
 
 scale_type = _swig_property(_fsdk.Excel2PDFSettingData_scale_type_get, _fsdk.Excel2PDFSettingData_scale_type_set)
 Scale type for the Excel sheet when converting Excel document to PDF file. Please refer to values starting from FoxitPDFSDKPython3.Excel2PDFSettingData.e_ScaleTypeNone and this should be one of these values.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Excel2PDFSettingData()

def FoxitPDFSDKPython3.Excel2PDFSettingData.Excel2PDFSettingData ( )

Constructor.

Constructor, with parameters.

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 FoxitPDFSDKPython3.Excel2PDFSettingData.e_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 FoxitPDFSDKPython3.Excel2PDFSettingData.e_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.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.Excel2PDFSettingData.e_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 FoxitPDFSDKPython3.Excel2PDFSettingData.e_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.

Member Data Documentation

◆ convert_to_pdfa

FoxitPDFSDKPython3.Excel2PDFSettingData.convert_to_pdfa = _swig_property(_fsdk.Excel2PDFSettingData_convert_to_pdfa_get, _fsdk.Excel2PDFSettingData_convert_to_pdfa_set)
static

(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.

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

◆ ignore_print_area

FoxitPDFSDKPython3.Excel2PDFSettingData.ignore_print_area = _swig_property(_fsdk.Excel2PDFSettingData_ignore_print_area_get, _fsdk.Excel2PDFSettingData_ignore_print_area_set)
static

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.

◆ include_doc_props

FoxitPDFSDKPython3.Excel2PDFSettingData.include_doc_props = _swig_property(_fsdk.Excel2PDFSettingData_include_doc_props_get, _fsdk.Excel2PDFSettingData_include_doc_props_set)
static

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.