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, Range page_range, boolean include_pdf_comments, PDF2WordSettingData word_setting_data, PDF2PowerPointSettingData power_point_setting_data, PDF2ExcelSettingData excel_setting_data)
 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...
 
PDF2ExcelSettingData getExcel_setting_data ()
 Get a setting data object that used for converting PDF documents to Excel format documents. More...
 
boolean getInclude_pdf_comments ()
 Get a boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. More...
 
String getMetrics_data_folder_path ()
 Get a valid path of a folder which contains metrics data files. More...
 
Range getPage_range ()
 Get a range object that specifies some pages. More...
 
PDF2PowerPointSettingData getPower_point_setting_data ()
 Get a setting data object that used for converting PDF documents to Power Point format documents. More...
 
PDF2WordSettingData getWord_setting_data ()
 Get a setting data object that used for converting PDF documents to Word format documents. More...
 
void set (String metrics_data_folder_path, boolean enable_ml_recognition, Range page_range, boolean include_pdf_comments, PDF2WordSettingData word_setting_data, PDF2PowerPointSettingData power_point_setting_data, PDF2ExcelSettingData excel_setting_data)
 Set value. More...
 
void setEnable_ml_recognition (boolean value)
 Set a boolean value which indicates whether enable machine learning-based recognition functionality. More...
 
void setExcel_setting_data (PDF2ExcelSettingData value)
 Set a setting data object that used for converting PDF documents to Excel format documents. More...
 
void setInclude_pdf_comments (boolean value)
 Set a boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. More...
 
void setMetrics_data_folder_path (String value)
 Set a valid path of a folder which contains metrics data files. More...
 
void setPage_range (Range value)
 Set a range object that specifies some pages. More...
 
void setPower_point_setting_data (PDF2PowerPointSettingData value)
 Set a setting data object that used for converting PDF documents to Power Point format documents. More...
 
void setWord_setting_data (PDF2WordSettingData value)
 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()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.PDF2OfficeSettingData ( String  metrics_data_folder_path,
boolean  enable_ml_recognition,
Range  page_range,
boolean  include_pdf_comments,
PDF2WordSettingData  word_setting_data,
PDF2PowerPointSettingData  power_point_setting_data,
PDF2ExcelSettingData  excel_setting_data 
)

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

◆ 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.
Returns
A boolean value which indicates whether enable machine learning-based recognition functionality.

◆ getExcel_setting_data()

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

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

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

◆ getInclude_pdf_comments()

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

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

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

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

◆ getPage_range()

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

Get a range object that specifies some pages.

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.

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

◆ getPower_point_setting_data()

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

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

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

◆ getWord_setting_data()

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

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

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

◆ set()

void com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.set ( String  metrics_data_folder_path,
boolean  enable_ml_recognition,
Range  page_range,
boolean  include_pdf_comments,
PDF2WordSettingData  word_setting_data,
PDF2PowerPointSettingData  power_point_setting_data,
PDF2ExcelSettingData  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.

◆ 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.
Parameters
[in]valueA boolean value which indicates whether enable machine learning-based recognition functionality.
Returns
None.

◆ setExcel_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setExcel_setting_data ( PDF2ExcelSettingData  value)

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

Parameters
[in]valueA setting data object that used for converting PDF documents to Excel format documents.
Returns
None.

◆ setInclude_pdf_comments()

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

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

Parameters
[in]valueA boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents.
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.

◆ setPage_range()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setPage_range ( Range  value)

Set a range object that specifies some pages.

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.

Parameters
[in]valueA range object that specifies some pages. These pages will be used to convert PDF documents to office format documents.
Returns
None.

◆ setPower_point_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setPower_point_setting_data ( PDF2PowerPointSettingData  value)

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

Parameters
[in]valueA setting data object that used for converting PDF documents to Power Point format documents.
Returns
None.

◆ setWord_setting_data()

com.foxit.sdk.conversion.pdf2office.PDF2OfficeSettingData.setWord_setting_data ( PDF2WordSettingData  value)

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

Parameters
[in]valueA setting data object that used for converting PDF documents to Word format documents.
Returns
None.