Foxit PDF Conversion SDK
com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData Class Reference

Public Member Functions

 PDF2OfficeSettingData ()
 Constructor.
 
 PDF2OfficeSettingData (String metrics_data_folder_path, boolean enable_ml_recognition)
 Constructor, with parameters. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean getEnable_ml_recognition ()
 Get a boolean value which indicates whether enable machine learning-based recognition functionality. More...
 
String getMetrics_data_folder_path ()
 Get a valid path of a folder which contains metrics data files. More...
 
void set (String metrics_data_folder_path, boolean enable_ml_recognition)
 Set value. More...
 
void setEnable_ml_recognition (boolean value)
 Set a boolean value which indicates whether enable machine learning-based recognition functionality. More...
 
void setMetrics_data_folder_path (String value)
 Set a valid path of a folder which contains metrics data files. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PDF2OfficeSettingData()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.PDF2OfficeSettingData ( String  metrics_data_folder_path,
boolean  enable_ml_recognition 
)

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

If it is a tagged PDF document, the parameter enable_ml_recognition will have no effect, and the default value is false.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

◆ getEnable_ml_recognition()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getEnable_ml_recognition ( )

Get 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. If it is a tagged PDF document, this parameter will have no effect, and the default value is false.
Returns
A boolean value which indicates whether enable machine learning-based recognition functionality.

◆ getMetrics_data_folder_path()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.getMetrics_data_folder_path ( )

Get a valid path of a folder which contains metrics data files.

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.

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

◆ set()

void com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.set ( String  metrics_data_folder_path,
boolean  enable_ml_recognition 
)

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.
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. If it is a tagged PDF document, the parameter enable_ml_recognition will have no effect, and the default value is false.
Returns
None.

◆ setEnable_ml_recognition()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setEnable_ml_recognition ( boolean  value)

Set 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. If it is a tagged PDF document, this parameter will have no effect, and the default value is false.
Parameters
[in]valueA boolean value which indicates whether enable machine learning-based recognition functionality.
Returns
None.

◆ setMetrics_data_folder_path()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setMetrics_data_folder_path ( String  value)

Set a valid path of a folder which contains metrics data files.

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.

Parameters
[in]valueA valid path of a folder which contains metrics data files. This should not be an empty string.
Returns
None.