Foxit PDF Conversion SDK
PDFConversionSDK.PDF2MdSettingData Class Reference

Public Member Functions

 constructor (table_format, include_header_footer, enable_italic, enable_bold, skip_ocr_pages?)
 Constructor, with parameters. More...
 
 Set (table_format, include_header_footer, enable_italic, enable_bold, skip_ocr_pages?)
 Set value. More...
 

Detailed Description

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

Member Function Documentation

◆ constructor()

PDFConversionSDK.PDF2MdSettingData.constructor (   table_format,
  include_header_footer,
  enable_italic,
  enable_bold,
  skip_ocr_pages? 
)
inline

Constructor, with parameters.

Parameters
[in]table_formatA PDFConversionSDK.TableFormat enumeration value which indicates the table format for the conversion of PDF documents to Markdown format documents. PDFConversionSDK.TableFormat.e_TableFormatMarkdown means to output table by Markdown pipe syntax. PDFConversionSDK.TableFormat.e_TableFormatHTML means to output table by HTML table syntax.
[in]include_header_footerA boolean value which indicates whether to include headers and footers for the conversion of PDF documents to Markdown format documents. Default value: false. true means to include headers and footers for the conversion of PDF documents to Markdown format documents. false means not to include headers and footers for the conversion of PDF documents to Markdown format documents.
[in]enable_italicA boolean value which indicates whether to enable italic text for the conversion of PDF documents to Markdown format documents. Default value: false. true means to enable italic text for the conversion of PDF documents to Markdown format documents. false means not to enable italic text for the conversion of PDF documents to Markdown format documents.
[in]enable_boldA boolean value which indicates whether to enable bold text for the conversion of PDF documents to Markdown format documents. Default value: false. true means to enable bold text for the conversion of PDF documents to Markdown format documents. false means not to enable bold text for the conversion of PDF documents to Markdown format documents.
[in]skip_ocr_pagesA boolean value which indicates whether to skip OCR pages for the conversion of PDF documents to Markdown format documents. Default value: false. true means to skip OCR pages for the conversion of PDF documents to Markdown format documents. false means not to skip OCR pages for the conversion of PDF documents to Markdown format documents.

◆ Set()

PDFConversionSDK.PDF2MdSettingData.Set (   table_format,
  include_header_footer,
  enable_italic,
  enable_bold,
  skip_ocr_pages? 
)
inline

Set value.

Parameters
[in]table_formatA PDFConversionSDK.TableFormat enumeration value which indicates the table format for the conversion of PDF documents to Markdown format documents. PDFConversionSDK.TableFormat.e_TableFormatMarkdown means to output table by Markdown pipe syntax. PDFConversionSDK.TableFormat.e_TableFormatHTML means to output table by HTML table syntax.
[in]include_header_footerA boolean value which indicates whether to include headers and footers for the conversion of PDF documents to Markdown format documents. true means to include headers and footers for the conversion of PDF documents to Markdown format documents. false means not to include headers and footers for the conversion of PDF documents to Markdown format documents.
[in]enable_italicA boolean value which indicates whether to enable italic text for the conversion of PDF documents to Markdown format documents. true means to enable italic text for the conversion of PDF documents to Markdown format documents. false means not to enable italic text for the conversion of PDF documents to Markdown format documents.
[in]enable_boldA boolean value which indicates whether to enable bold text for the conversion of PDF documents to Markdown format documents. true means to enable bold text for the conversion of PDF documents to Markdown format documents. false means not to enable bold text for the conversion of PDF documents to Markdown format documents.
[in]skip_ocr_pagesA boolean value which indicates whether to skip OCR pages for the conversion of PDF documents to Markdown format documents. true means to skip OCR pages for the conversion of PDF documents to Markdown format documents. false means not to skip OCR pages for the conversion of PDF documents to Markdown format documents.
Returns
None.