Foxit PDF Conversion SDK
foxit::conversion::pdf2office::PDF2WordSettingData Class Reference

Inherits Object.

Public Member Functions

 PDF2WordSettingData ()
 Constructor.
 
 PDF2WordSettingData (bool enable_retain_page_layout, bool enable_generate_headers_and_footers, bool enable_generate_footnotes_and_endnotes)
 Constructor, with parameters. More...
 
PDF2WordSettingDataoperator= (const PDF2WordSettingData &data)
 Assign operator. More...
 
void Set (bool enable_retain_page_layout, bool enable_generate_headers_and_footers, bool enable_generate_footnotes_and_endnotes)
 Set value. More...
 

Public Attributes

bool enable_generate_footnotes_and_endnotes
 A boolean value which indicates whether convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of word format documents during the conversion of PDF documents to word format documents. Default value: false. More...
 
bool enable_generate_headers_and_footers
 A boolean value which indicates whether convert the recognized headers and footers from PDF documents to headers and footers of word format documents during the conversion of PDF documents to word format documents. Default value: false. More...
 
bool enable_retain_page_layout
 A boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents. Default value: false. More...
 

Detailed Description

This class represents setting data used for converting PDF documents to Word format documents.

Constructor & Destructor Documentation

◆ PDF2WordSettingData()

foxit::conversion::pdf2office::PDF2WordSettingData::PDF2WordSettingData ( bool  enable_retain_page_layout,
bool  enable_generate_headers_and_footers,
bool  enable_generate_footnotes_and_endnotes 
)
inline

Constructor, with parameters.

Parameters
[in]enable_retain_page_layoutA boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents. Default value: false. true means to retain page layout for the conversion of PDF documents to Word format documents. false means not to retain page layout for the conversion of PDF documents to Word format documents.
[in]enable_generate_headers_and_footersA boolean value which indicates whether convert the recognized headers and footers from PDF documents to headers and footers of Word format documents during the conversion of PDF documents to Word format documents. Default value: false. true means to convert the recognized headers and footers from PDF documents to headers and footers of Word format documents. false means to convert the recognized headers and footers from PDF documents to the main texts or text boxes of Word format documents.
[in]enable_generate_footnotes_and_endnotesA boolean value which indicates whether convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of Word format documents during the conversion of PDF documents to Word format documents. Default value: false. true means to convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of Word format documents. false means to convert the recognized footnotes and endnotes from PDF documents to the main texts or text boxes of Word format documents. Default value:false.

Member Function Documentation

◆ operator=()

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

Assign operator.

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

◆ Set()

void foxit::conversion::pdf2office::PDF2WordSettingData::Set ( bool  enable_retain_page_layout,
bool  enable_generate_headers_and_footers,
bool  enable_generate_footnotes_and_endnotes 
)
inline

Set value.

Parameters
[in]enable_retain_page_layoutA boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents. Default value: false. true means to retain page layout for the conversion of PDF documents to Word format documents. false means not to retain page layout for the conversion of PDF documents to Word format documents.
[in]enable_generate_headers_and_footersA boolean value which indicates whether convert the recognized headers and footers from PDF documents to headers and footers of Word format documents during the conversion of PDF documents to Word format documents. Default value: false. true means to convert the recognized headers and footers from PDF documents to headers and footers of Word format documents. false means to convert the recognized headers and footers from PDF documents to the main texts or text boxes of Word format documents.
[in]enable_generate_footnotes_and_endnotesA boolean value which indicates whether convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of Word format documents during the conversion of PDF documents to Word format documents. Default value: false. true means to convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of Word format documents. false means to convert the recognized footnotes and endnotes from PDF documents to the main texts or text boxes of Word format documents. Default value:false.
Returns
None.

Member Data Documentation

◆ enable_generate_footnotes_and_endnotes

bool foxit::conversion::pdf2office::PDF2WordSettingData::enable_generate_footnotes_and_endnotes

A boolean value which indicates whether convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of word format documents during the conversion of PDF documents to word format documents. Default value: false.

true means to convert the recognized footnotes and endnotes from PDF documents to footnotes and endnotes of word format documents. false means to convert the recognized footnotes and endnotes from PDF documents to the main texts or text boxes of word format documents.

◆ enable_generate_headers_and_footers

bool foxit::conversion::pdf2office::PDF2WordSettingData::enable_generate_headers_and_footers

A boolean value which indicates whether convert the recognized headers and footers from PDF documents to headers and footers of word format documents during the conversion of PDF documents to word format documents. Default value: false.

true means to convert the recognized headers and footers from PDF documents to headers and footers of word format documents. false means to convert the recognized headers and footers from PDF documents to the main texts or text boxes of word format documents.

◆ enable_retain_page_layout

bool foxit::conversion::pdf2office::PDF2WordSettingData::enable_retain_page_layout

A boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents. Default value: false.

true means to retain page layout for the conversion of PDF documents to Word format documents. false means not to retain page layout for the conversion of PDF documents to Word format documents.