Foxit PDF SDK
foxit::addon::conversion::pdf2office::PDF2OfficeSettingData Class Reference

Inherits Object.

Public Member Functions

 PDF2OfficeSettingData ()
 Constructor.
 
 PDF2OfficeSettingData (const wchar_t *metrics_data_folder_path, bool enable_ml_recognition, const common::Range &page_range, bool include_pdf_comments, const PDF2WordSettingData &word_setting_data, const PDF2PowerPointSettingData &power_point_setting_data, const PDF2ExcelSettingData &excel_setting_data, bool enable_trailing_space, bool include_images, int timeout)
 Constructor, with parameters. More...
 
PDF2OfficeSettingDataoperator= (const PDF2OfficeSettingData &data)
 Assign operator. More...
 
void Set (const wchar_t *metrics_data_folder_path, bool enable_ml_recognition, const common::Range &page_range, bool include_pdf_comments, const PDF2WordSettingData &word_setting_data, const PDF2PowerPointSettingData &power_point_setting_data, const PDF2ExcelSettingData &excel_setting_data, bool enable_trailing_space, bool include_images, int timeout)
 Set value. More...
 

Public Attributes

bool enable_ml_recognition
 A boolean value which indicates whether enable machine learning-based recognition functionality. Default value: false. More...
 
bool enable_trailing_space
 A boolean value which indicates whether to add trailing spaces from lines in paragraphs for converting PDF documents to office format documents. Default value: true. More...
 
PDF2ExcelSettingData excel_setting_data
 A setting data object that used for converting PDF documents to Excel format documents. More...
 
bool include_images
 A boolean value which indicates whether to include images in PDF documents for converting PDF documents to office format documents. Default value: true/b>. More...
 
bool include_pdf_comments
 A boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. Default value: true. More...
 
WString metrics_data_folder_path
 A valid path of a folder which contains metrics data files. This should not be an empty string. More...
 
common::Range page_range
 A range object that specifies some pages. These pages will be used to convert PDF documents to office format documents. More...
 
PDF2PowerPointSettingData power_point_setting_data
 A setting data object that used for converting PDF documents to Power Point format documents. More...
 
int timeout
 Milliseconds for timeout used for PDF Conversion. More...
 
PDF2WordSettingData word_setting_data
 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()

foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::PDF2OfficeSettingData ( const wchar_t *  metrics_data_folder_path,
bool  enable_ml_recognition,
const common::Range page_range,
bool  include_pdf_comments,
const PDF2WordSettingData word_setting_data,
const PDF2PowerPointSettingData power_point_setting_data,
const PDF2ExcelSettingData excel_setting_data,
bool  enable_trailing_space,
bool  include_images,
int  timeout 
)
inline

Constructor, with parameters.

Parameters
[in]metrics_data_folder_path(Deprecated)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.
[in]enable_ml_recognitionA boolean value which indicates whether enable machine learning-based recognition functionality. Default value: false. 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_commentsA boolean value which indicates whether to include PDF documents comments for the conversion of PDF documents to office format documents. Default value: true. 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_dataA setting data object that used for converting PDF documents to Word format documents.
[in]power_point_setting_dataA setting data object that used for converting PDF documents to Power Point format documents.
[in]excel_setting_dataA setting data object that used for converting PDF documents to Excel format documents.
[in]enable_trailing_spaceA boolean value which indicates whether to add trailing spaces from lines in paragraphs.for converting PDF documents to office format documents. Default value: true. true means to add trailing spaces from lines in paragraphs for converting PDF documents to office format documents. false means not to add trailing spaces from lines in paragraphs and add a property to the paragraph that allows for line breaks. Currently, this support is limited to paragraphs where more than 80% of the text involves the end of one line and the beginning of the next both being in Korean. This is only available for converting PDF documents to Word format documents, with support for other Office formats planned for the future.
[in]include_imagesA boolean value which indicates whether to include images in PDF documents for converting PDF documents to office format documents. Default value: true/b>. true means to include images in PDF documents for converting PDF documents to office format documents. false means not to include images in PDF documents PDF documents to office format documents. This is only available for converting PDF documents to Word format documents, with support for other Office formats planned for the future.
[in]timeout Milliseconds for timeout used for PDF Conversion. Default value: 0.
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

◆ operator=()

PDF2OfficeSettingData& foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::operator= ( const PDF2OfficeSettingData data)
inline

Assign operator.

Parameters
[in]dataAnother PDF-to-Office setting data object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::Set ( const wchar_t *  metrics_data_folder_path,
bool  enable_ml_recognition,
const common::Range page_range,
bool  include_pdf_comments,
const PDF2WordSettingData word_setting_data,
const PDF2PowerPointSettingData power_point_setting_data,
const PDF2ExcelSettingData excel_setting_data,
bool  enable_trailing_space,
bool  include_images,
int  timeout 
)
inline

Set value.

Parameters
[in]metrics_data_folder_path(Deprecated)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.
[in]enable_ml_recognitionA boolean value which indicates whether enable machine learning-based recognition functionality. Default value: false. 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. Default value: true. 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_dataA setting data object that used for converting PDF documents to Word format documents.
[in]power_point_setting_dataA setting data object that used for converting PDF documents to Power Point format documents.
[in]excel_setting_dataA setting data object that used for converting PDF documents to Excel format documents.
[in]enable_trailing_spaceA boolean value which indicates whether to add trailing spaces from lines in paragraphs.for converting PDF documents to office format documents. Default value: true. true means to add trailing spaces from lines in paragraphs for converting PDF documents to office format documents. false means not to add trailing spaces from lines in paragraphs and add a property to the paragraph that allows for line breaks. Currently, this support is limited to paragraphs where more than 80% of the text involves the end of one line and the beginning of the next both being in Korean. This is only available for converting PDF documents to Word format documents, with support for other Office formats planned for the future.
[in]include_imagesA boolean value which indicates whether to include images in PDF documents for converting PDF documents to office format documents. Default value: true/b>. true means to include images in PDF documents for converting PDF documents to office format documents. false means not to include images in PDF documents PDF documents to office format documents. This is only available for converting PDF documents to Word format documents, with support for other Office formats planned for the future.
[in]timeout Milliseconds for timeout used for PDF Conversion. Default value: 0.
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

bool foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::enable_ml_recognition

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

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.

◆ enable_trailing_space

bool foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::enable_trailing_space

A boolean value which indicates whether to add trailing spaces from lines in paragraphs for converting PDF documents to office format documents. Default value: true.

true means to add trailing spaces from lines in paragraphs for converting PDF documents to office format documents. false means not to add trailing spaces from lines in paragraphs and add a property to the paragraph that allows for line breaks. Currently, this support is limited to paragraphs where more than 80% of the text involves the end of one line and the beginning of the next both being in Korean. This is only available for converting PDF documents to Word format documents, with support for other Office formats planned for the future.

◆ excel_setting_data

PDF2ExcelSettingData foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::excel_setting_data

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_images

bool foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::include_images

A boolean value which indicates whether to include images in PDF documents for converting PDF documents to office format documents. Default value: true/b>.

true means to include images in PDF documents for converting PDF documents to office format documents. false means not to include images in PDF documents PDF documents to office format documents. This is only available for converting PDF documents to Word format documents, with support for other Office formats planned for the future.

◆ include_pdf_comments

bool foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::include_pdf_comments

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

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

WString foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::metrics_data_folder_path

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

Deprecated:
Current property has been deprecated since Foxit PDF SDK 10.1. Instead, metrics data will be included in the dynamic library.

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

common::Range foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::page_range

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). count is returned by function PDFDoc::GetPageCount. 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

PDF2PowerPointSettingData foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::power_point_setting_data

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.

◆ timeout

int foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::timeout

Milliseconds for timeout used for PDF Conversion.

If the conversion process is not completed within the specified time, the conversion process will be terminated. This should be a non-negative value. If the value is 0, that means no timeout processing for PDF Conversion.
This parameter only useful when Foxit PDF Conversion engine is set by function PDF2Office::Initialize. Default value: 0.

Note
Resource release may take some time, so the time spent on the entire conversion process may exceed the time set by this parameter.

◆ word_setting_data

PDF2WordSettingData foxit::addon::conversion::pdf2office::PDF2OfficeSettingData::word_setting_data

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.