Foxit PDF Conversion SDK
foxit::conversion::pdf2md::PDF2MdSettingData Class Reference

Inherits Object.

Public Types

enum  TableFormat { e_TableFormatMarkdown = 0, e_TableFormatHTML = 1 }
 Enumeration for table output format in Markdown conversion. More...
 

Public Member Functions

 PDF2MdSettingData ()
 Constructor.
 
 PDF2MdSettingData (TableFormat table_format, bool include_header_footer, bool enable_italic, bool enable_bold, bool skip_ocr_pages=false)
 Constructor, with parameters. More...
 
PDF2MdSettingData & operator= (const PDF2MdSettingData &data)
 Assign operator. More...
 

Public Attributes

bool enable_bold
 Whether to preserve bold formatting from the original PDF. When true, text that is bold in the PDF will have bold markers in output; when false (default), bold formatting is stripped. Has no effect on text that is not bold in the PDF.
 
bool enable_italic
 Whether to preserve italic formatting from the original PDF. When true (default), text that is italic in the PDF will have italic markers in output; when false, italic formatting is stripped. Has no effect on text that is not italic in the PDF.
 
bool include_header_footer
 Whether to include page header/footer (artifact) content. Default: false.
 
bool skip_ocr_pages
 Whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR). When false (default), such pages cause e_ErrNeedOCR to be thrown. When true, such pages are skipped and conversion continues.
 
TableFormat table_format
 Table output format. Default value: e_TableFormatMarkdown.
 

Detailed Description

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

Member Enumeration Documentation

◆ TableFormat

Enumeration for table output format in Markdown conversion.

Values of this enumeration should be used alone.

Enumerator
e_TableFormatMarkdown 

Table format: Markdown pipe syntax (default).

e_TableFormatHTML 

Table format: HTML table tags.

Constructor & Destructor Documentation

◆ PDF2MdSettingData()

foxit::conversion::pdf2md::PDF2MdSettingData::PDF2MdSettingData ( TableFormat  table_format,
bool  include_header_footer,
bool  enable_italic,
bool  enable_bold,
bool  skip_ocr_pages = false 
)
inline

Constructor, with parameters.

Parameters
[in]table_formatTable output format. Default: e_TableFormatMarkdown.
[in]include_header_footerWhether to include page header/footer content. Default: false.
[in]enable_italicWhether to apply italic markers in output. Default: true.
[in]enable_boldWhether to apply bold markers in output. Default: false.
[in]skip_ocr_pagesWhether to silently skip scan-only pages instead of throwing e_ErrNeedOCR. Default: false.

Member Function Documentation

◆ operator=()

PDF2MdSettingData& foxit::conversion::pdf2md::PDF2MdSettingData::operator= ( const PDF2MdSettingData &  data)
inline

Assign operator.

Parameters
[in]dataAnother PDF-to-Markdown setting data object.
Returns
Reference to current object itself.