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

Public Member Functions

 PDF2WordSettingData ()
 Constructor.
 
 PDF2WordSettingData (boolean enable_retain_page_layout, boolean enable_generate_headers_and_footers, boolean enable_generate_footnotes_and_endnotes)
 Constructor, with parameters. More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
boolean getEnable_generate_footnotes_and_endnotes ()
 Get 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. More...
 
boolean getEnable_generate_headers_and_footers ()
 Get 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. More...
 
boolean getEnable_retain_page_layout ()
 Get a boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents. More...
 
void set (boolean enable_retain_page_layout, boolean enable_generate_headers_and_footers, boolean enable_generate_footnotes_and_endnotes)
 Set value. More...
 
void setEnable_generate_footnotes_and_endnotes (boolean value)
 Set 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. More...
 
void setEnable_generate_headers_and_footers (boolean value)
 Set 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. More...
 
void setEnable_retain_page_layout (boolean value)
 Set a boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PDF2WordSettingData()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.PDF2WordSettingData ( boolean  enable_retain_page_layout,
boolean  enable_generate_headers_and_footers,
boolean  enable_generate_footnotes_and_endnotes 
)

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

◆ delete()

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

Clean up related resources immediately.

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

◆ getEnable_generate_footnotes_and_endnotes()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.getEnable_generate_footnotes_and_endnotes ( )

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

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.

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

◆ getEnable_generate_headers_and_footers()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.getEnable_generate_headers_and_footers ( )

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

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.

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

◆ getEnable_retain_page_layout()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.getEnable_retain_page_layout ( )

Get a boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents.

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.

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

◆ set()

void com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.set ( boolean  enable_retain_page_layout,
boolean  enable_generate_headers_and_footers,
boolean  enable_generate_footnotes_and_endnotes 
)

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

◆ setEnable_generate_footnotes_and_endnotes()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.setEnable_generate_footnotes_and_endnotes ( boolean  value)

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

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.

Parameters
[in]valueA 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.
Returns
None.

◆ setEnable_generate_headers_and_footers()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.setEnable_generate_headers_and_footers ( boolean  value)

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

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.

Parameters
[in]valueA 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.
Returns
None.

◆ setEnable_retain_page_layout()

com.foxit.sdk.conversion.pdf2office.PDF2WordSettingData.setEnable_retain_page_layout ( boolean  value)

Set a boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents.

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.

Parameters
[in]valueA boolean value which indicates whether retain page layout for the conversion of PDF documents to Word format documents.
Returns
None.