Foxit PDF SDK
FSDK.PDF2WordSettingData Class Reference

Public Member Functions

 constructor ()
 Constructor.
 
 constructor (enable_retain_page_layout, enable_generate_headers_and_footers, enable_generate_footnotes_and_endnotes, enable_generate_page_rendered_break)
 Constructor, with parameters. More...
 
 Set (enable_retain_page_layout, enable_generate_headers_and_footers, enable_generate_footnotes_and_endnotes, enable_generate_page_rendered_break)
 Set value. More...
 

Public Attributes

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

Member Function Documentation

◆ 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 retain page layout for the conversion of PDF documents to word format documents. false means not retain page layout for the conversion of PDF documents to word format documents.
[in]enable_generate_headers_and_footersA boolean value which indicates whether to include PDF headers and footers for the conversion of PDF documents to word format documents. Default value: false. true means to include PDF headers and footers for the conversion of PDF documents to word format documents. false means not to include PDF headers and footers for the conversion of PDF documents to 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.

◆ Set()

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 retain page layout for the conversion of PDF documents to word format documents. false means not retain page layout for the conversion of PDF documents to word format documents.
[in]enable_generate_headers_and_footersA boolean value which indicates whether to include PDF headers and footers for the conversion of PDF documents to word format documents. Default value: false. true means to include PDF headers and footers for the conversion of PDF documents to word format documents. false means not to include PDF headers and footers for the conversion of PDF documents to 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 Data Documentation

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

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

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.

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

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.

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.

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

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