Foxit PDF SDK
FoxitPDFSDKPython3.PDF2WordSettingData Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def PDF2WordSettingData ()
 Constructor. More...
 
def Set (enable_retain_page_layout, enable_generate_headers_and_footers, enable_generate_footnotes_and_endnotes, enable_generate_page_rendered_break)
 Set value. More...
 

Static Public Attributes

 enable_generate_footnotes_and_endnotes = _fsdk.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. More...
 
 enable_generate_headers_and_footers = _fsdk.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. More...
 
 enable_generate_page_rendered_break = _fsdk.PDF2WordSettingData_enable_generate_page_rendered_break
 A boolean value which indicates whether to generate the "lastRenderedPageBreak" marker in word format documents during the conversion of PDF documents to Word format documents. Default value: false. More...
 
 enable_retain_page_layout = _fsdk.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. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ PDF2WordSettingData()

def FoxitPDFSDKPython3.PDF2WordSettingData.PDF2WordSettingData ( )

Constructor.

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.
[in]enable_generate_page_rendered_breakA boolean value which indicates whether to generate the "lastRenderedPageBreak" marker in word format documents during the conversion of PDF documents to Word format documents.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.PDF2WordSettingData.Set (   enable_retain_page_layout,
  enable_generate_headers_and_footers,
  enable_generate_footnotes_and_endnotes,
  enable_generate_page_rendered_break 
)

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.
[in]enable_generate_page_rendered_breakA boolean value which indicates whether to generate the "lastRenderedPageBreak" marker in word format documents during the conversion of PDF documents to Word format documents.
Returns
None.

Member Data Documentation

◆ enable_generate_footnotes_and_endnotes

FoxitPDFSDKPython3.PDF2WordSettingData.enable_generate_footnotes_and_endnotes = _fsdk.PDF2WordSettingData_enable_generate_footnotes_and_endnotes
static

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

FoxitPDFSDKPython3.PDF2WordSettingData.enable_generate_headers_and_footers = _fsdk.PDF2WordSettingData_enable_generate_headers_and_footers
static

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_generate_page_rendered_break

FoxitPDFSDKPython3.PDF2WordSettingData.enable_generate_page_rendered_break = _fsdk.PDF2WordSettingData_enable_generate_page_rendered_break
static

A boolean value which indicates whether to generate the "lastRenderedPageBreak" marker in word format documents during the conversion of PDF documents to Word format documents. Default value: false.

If true, the "lastRenderedPageBreak" marker will be inserted into the Word document to denote the pagination position from the last PDF rendering. If false, the "lastRenderedPageBreak" marker will not be inserted. "lastRenderedPageBreak" is a marker that indicates the location of a page break that was inserted when the document was last saved or rendered in an application. It is particularly useful for applications that need to track where content was split across pages during the document's rendering process.

◆ enable_retain_page_layout

FoxitPDFSDKPython3.PDF2WordSettingData.enable_retain_page_layout = _fsdk.PDF2WordSettingData_enable_retain_page_layout
static

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.