Foxit PDF Conversion SDK
fpdfconversionsdk.PDF2WordSettingData Class Reference

Public Member Functions

def 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...
 
def 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 in word format documents during the conversion of PDF documents to word format documents. More...
 
def GetEnable_generate_page_rendered_break ()
 Get 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. More...
 
def 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...
 
def Set (enable_retain_page_layout, enable_generate_headers_and_footers, enable_generate_footnotes_and_endnotes, enable_generate_page_rendered_break)
 Set value. More...
 
def SetEnable_generate_footnotes_and_endnotes (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...
 
def SetEnable_generate_headers_and_footers (value)
 Set a boolean value which indicates whether convert the recognized headers and footers from PDF documents to headers and footers in word format documents during the conversion of PDF documents to word format documents. More...
 
def SetEnable_generate_page_rendered_break (value)
 Set 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. More...
 
def SetEnable_retain_page_layout (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.

Member Function Documentation

◆ GetEnable_generate_footnotes_and_endnotes()

fpdfconversionsdk.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. Default value: false.

◆ GetEnable_generate_headers_and_footers()

fpdfconversionsdk.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 in 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 in word format documents during the conversion of PDF documents to word format documents. Default value: false.

◆ GetEnable_generate_page_rendered_break()

fpdfconversionsdk.PDF2WordSettingData.GetEnable_generate_page_rendered_break ( )

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

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.

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

◆ GetEnable_retain_page_layout()

fpdfconversionsdk.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. Default value: false.

◆ Set()

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

◆ SetEnable_generate_footnotes_and_endnotes()

fpdfconversionsdk.PDF2WordSettingData.SetEnable_generate_footnotes_and_endnotes (   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. Default value: false.
Returns
None.

◆ SetEnable_generate_headers_and_footers()

fpdfconversionsdk.PDF2WordSettingData.SetEnable_generate_headers_and_footers (   value)

Set a boolean value which indicates whether convert the recognized headers and footers from PDF documents to headers and footers in 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 in word format documents during the conversion of PDF documents to word format documents. Default value: false.
Returns
None.

◆ SetEnable_generate_page_rendered_break()

fpdfconversionsdk.PDF2WordSettingData.SetEnable_generate_page_rendered_break (   value)

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

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.

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

◆ SetEnable_retain_page_layout()

fpdfconversionsdk.PDF2WordSettingData.SetEnable_retain_page_layout (   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. Default value: false.
Returns
None.