Foxit PDF Conversion SDK
FoxitPDFConversionSDKPython3.PDF2OfficeSettingData Class Reference

Inherits FoxitPDFConversionSDKPython3._object.

Public Member Functions

def PDF2OfficeSettingData ()
 Constructor. More...
 
def Set (metrics_data_folder_path, enable_ml_recognition, page_range, include_pdf_comments, word_setting_data, power_point_setting_data, excel_setting_data)
 Set value. More...
 

Static Public Attributes

 enable_ml_recognition = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_enable_ml_recognition_get, _fpdfconversionsdk.PDF2OfficeSettingData_enable_ml_recognition_set)
 A boolean value which indicates whether enable machine learning-based recognition functionality. More...
 
 excel_setting_data = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_excel_setting_data_get, _fpdfconversionsdk.PDF2OfficeSettingData_excel_setting_data_set)
 A setting data object that used for converting PDF documents to Excel format documents. More...
 
 include_pdf_comments = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_include_pdf_comments_get, _fpdfconversionsdk.PDF2OfficeSettingData_include_pdf_comments_set)
 A boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. More...
 
 metrics_data_folder_path = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_metrics_data_folder_path_get, _fpdfconversionsdk.PDF2OfficeSettingData_metrics_data_folder_path_set)
 A valid path of a folder which contains metrics data files. This should not be an empty string. More...
 
 page_range = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_page_range_get, _fpdfconversionsdk.PDF2OfficeSettingData_page_range_set)
 A range object that specifies some pages. These pages will be used to convert PDF documents to office format documents. More...
 
 power_point_setting_data = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_power_point_setting_data_get, _fpdfconversionsdk.PDF2OfficeSettingData_power_point_setting_data_set)
 A setting data object that used for converting PDF documents to Power Point format documents. More...
 
 word_setting_data = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_word_setting_data_get, _fpdfconversionsdk.PDF2OfficeSettingData_word_setting_data_set)
 A setting data object that used for converting PDF documents to Word format documents. More...
 

Detailed Description

This class represents setting data used for converting PDF to Office(Word, Excel or PowerPoint) format file.

Constructor & Destructor Documentation

◆ PDF2OfficeSettingData()

def FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.PDF2OfficeSettingData ( )

Constructor.

Constructor, with parameters.

Parameters
[in]metrics_data_folder_pathA valid path of a folder which contains metrics data files. This should not be an empty string. These metrics data files are used to simulate the office format document typesetting process during conversion. They are offered in the "res/metrics_data" folder of the Foxit PDF Conversion SDK package.
[in]enable_ml_recognitionA boolean value which indicates whether enable machine learning-based recognition functionality. true means enable machine learning-based recognition functionality to identify borderless tables in PDF documents. In order to convert the tables better, it will draw a black border with a width of 1 on the recognized borderless table. This will be improved in subsequent versions. And this recognition functionality will be executed on the server side and return the relevant results when it is done. false means disable machine learning-based recognition functionality. And the recognition functionality not based on machine learning will be enabled.
[in]page_rangeA range object that specifies some pages. These pages will be used to convert PDF document to office format documents.
[in]include_pdf_comments A boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. true means to include PDF document comments for the conversion of PDF documents to office format documents. false means not to include PDF document comments for the conversion of PDF documents to office format documents.
[in]word_setting_data A setting data object that used for converting PDF documents to Word format documents.
[in]power_point_setting_data A setting data object that used for converting PDF documents to Power Point format documents.
[in]excel_setting_data A setting data object that used for converting PDF documents to Excel format documents.
Note
Our machine learning-based technology for identifying borderless tables uses HTTPS and requires a network connection to send the images of the rendered PDF pages to our server during the conversion process.

Member Function Documentation

◆ Set()

def FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.Set (   metrics_data_folder_path,
  enable_ml_recognition,
  page_range,
  include_pdf_comments,
  word_setting_data,
  power_point_setting_data,
  excel_setting_data 
)

Set value.

Parameters
[in]metrics_data_folder_pathA valid path of a folder which contains metrics data files. This should not be an empty string. These metrics data files are used to simulate the office format document typesetting process during conversion. They are offered in the "res/metrics_data" folder of the Foxit PDF Conversion SDK package.
[in]enable_ml_recognitionA boolean value which indicates whether enable machine learning-based recognition functionality. true means enable machine learning-based recognition functionality to identify borderless tables in PDF documents. In order to convert the tables better, it will draw a black border with a width of 1 on the recognized borderless table. This will be improved in subsequent versions. And this recognition functionality will be executed on the server side and return the relevant results when it is done. false means disable machine learning-based recognition functionality. And the recognition functionality not based on machine learning will be enabled.
[in]page_rangeA range object that specifies some pages. These pages will be used to convert PDF documents to office format documents.
[in]include_pdf_commentsA boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. true means to include PDF document comments for the conversion of PDF documents to office format documents. false means not to include PDF document comments for the conversion of PDF documents to office format documents.
[in]word_setting_data A setting data object that used for converting PDF documents to Word format documents.
[in]power_point_setting_data A setting data object that used for converting PDF documents to Power Point format documents.
[in]excel_setting_data A setting data object that used for converting PDF documents to Excel format documents.
Note
Our machine learning-based technology for identifying borderless tables uses HTTPS and requires a network connection to send the images of the rendered PDF pages to our server during the conversion process.
Returns
None.

Member Data Documentation

◆ enable_ml_recognition

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.enable_ml_recognition = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_enable_ml_recognition_get, _fpdfconversionsdk.PDF2OfficeSettingData_enable_ml_recognition_set)
static

A boolean value which indicates whether enable machine learning-based recognition functionality.

true means enable machine learning-based recognition functionality to identify borderless tables in PDF documents. And this recognition functionality will be executed on the server side and return the relevant results when it is done. In order to convert the tables better, it will draw a black border with a width of 1 on the recognized borderless table. This will be improved in subsequent versions. false means disable machine learning-based recognition functionality. And the recognition functionality not based on machine learning will be enabled.

Note
Our machine learning-based technology for identifying borderless tables uses HTTPS and requires a network connection to send the images of the rendered PDF pages to our server during the conversion process.

◆ excel_setting_data

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.excel_setting_data = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_excel_setting_data_get, _fpdfconversionsdk.PDF2OfficeSettingData_excel_setting_data_set)
static

A setting data object that used for converting PDF documents to Excel format documents.

This setting is only vaild for the conversion of PDF documents to Excel format documents. For more details, please refer to class PDF2ExcelSettingData .

◆ include_pdf_comments

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.include_pdf_comments = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_include_pdf_comments_get, _fpdfconversionsdk.PDF2OfficeSettingData_include_pdf_comments_set)
static

A boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents.

true means to include PDF document comments for the conversion of PDF documents to office format documents. false means not to include PDF document comments for the conversion of PDF documents to office format documents.

◆ metrics_data_folder_path

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.metrics_data_folder_path = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_metrics_data_folder_path_get, _fpdfconversionsdk.PDF2OfficeSettingData_metrics_data_folder_path_set)
static

A valid path of a folder which contains metrics data files. This should not be an empty string.

These metrics data files are used to simulate the office format document typesetting process during conversion. They are offered in the "res/metrics_data" folder of the Foxit PDF Conversion SDK package.

◆ page_range

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.page_range = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_page_range_get, _fpdfconversionsdk.PDF2OfficeSettingData_page_range_set)
static

A range object that specifies some pages. These pages will be used to convert PDF documents to office format documents.

The valid page range: from 0 to (count - 1), where count is the total page count of the PDF documents. If this range object is constructed by default constructor and not set any value, that means all the pages of current document will be used to convert PDF documents to office format documents.

◆ power_point_setting_data

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.power_point_setting_data = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_power_point_setting_data_get, _fpdfconversionsdk.PDF2OfficeSettingData_power_point_setting_data_set)
static

A setting data object that used for converting PDF documents to Power Point format documents.

This setting is only vaild for the conversion of PDF documents to Power Point format documents. For more details, please refer to class PDF2PowerPointSettingData .

◆ word_setting_data

FoxitPDFConversionSDKPython3.PDF2OfficeSettingData.word_setting_data = _swig_property(_fpdfconversionsdk.PDF2OfficeSettingData_word_setting_data_get, _fpdfconversionsdk.PDF2OfficeSettingData_word_setting_data_set)
static

A setting data object that used for converting PDF documents to Word format documents.

This setting is only vaild for the conversion of PDF documents to word format documents. For more details, please refer to class PDF2WordSettingData .