foxit.addon.conversion.pdf2md.PDF2MdSettingData Class Reference

Inherits SystemIDisposable.

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

Public Member Functions
	PDF2MdSettingData ()
	Constructor.
	PDF2MdSettingData (PDF2MdSettingData.TableFormat table_format, bool include_header_footer, bool enable_italic, bool enable_bold, bool skip_ocr_pages)
	Constructor, with parameters. More...
void	Set (PDF2MdSettingData.TableFormat table_format, bool include_header_footer, bool enable_italic, bool enable_bold, bool skip_ocr_pages)
	Set value. More...

Properties
bool	enable_bold [get, set]
	Whether to preserve bold formatting from the original PDF. Default: false. More...
bool	enable_italic [get, set]
	Whether to preserve italic formatting from the original PDF. Default: true. More...
bool	include_header_footer [get, set]
	Whether to include page header/footer (artifact) content. Default: false. More...
bool	skip_ocr_pages [get, set]
	Whether to silently skip pages that contain only path/image objects. Default: false. More...
PDF2MdSettingData.TableFormat	table_format [get, set]
	Table output format. Default value: . More...

Detailed Description

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

Member Enumeration Documentation

TableFormat

enum foxit.addon.conversion.pdf2md.PDF2MdSettingData.TableFormat

strong

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.addon.conversion.pdf2md.PDF2MdSettingData.PDF2MdSettingData ( PDF2MdSettingData.TableFormat  table_format, bool  include_header_footer, bool  enable_italic, bool  enable_bold, bool  skip_ocr_pages  )

inline

Constructor, with parameters.

Parameters

[in]	table_format	Table output format. Default: .
[in]	include_header_footer	Whether to include page header/footer content. Default: false.
[in]	enable_italic	Whether to apply italic markers in output. Default: true.
[in]	enable_bold	Whether to apply bold markers in output. Default: false.
[in]	skip_ocr_pages	Whether to silently skip scan-only pages. Default: false.

Member Function Documentation

Set()

void foxit.addon.conversion.pdf2md.PDF2MdSettingData.Set ( PDF2MdSettingData.TableFormat  table_format, bool  include_header_footer, bool  enable_italic, bool  enable_bold, bool  skip_ocr_pages  )

inline

Set value.

Parameters

[in]	table_format	Table output format.
[in]	include_header_footer	Whether to include page header/footer content.
[in]	enable_italic	Whether to apply italic markers in output.
[in]	enable_bold	Whether to apply bold markers in output.
[in]	skip_ocr_pages	Whether to silently skip scan-only pages.

Returns

None.

Property Documentation

enable_bold

bool foxit.addon.conversion.pdf2md.PDF2MdSettingData.enable_bold

getset

Whether to preserve bold formatting from the original PDF. Default: false.

When true, text that is bold in the PDF will have bold markers in output. When false, bold formatting is stripped.

enable_italic

bool foxit.addon.conversion.pdf2md.PDF2MdSettingData.enable_italic

getset

Whether to preserve italic formatting from the original PDF. Default: true.

When true, text that is italic in the PDF will have italic markers in output. When false, italic formatting is stripped.

include_header_footer

bool foxit.addon.conversion.pdf2md.PDF2MdSettingData.include_header_footer

getset

Whether to include page header/footer (artifact) content. Default: false.

true means to include header/footer text in the output Markdown. false means to skip header/footer text.

skip_ocr_pages

bool foxit.addon.conversion.pdf2md.PDF2MdSettingData.skip_ocr_pages

getset

Whether to silently skip pages that contain only path/image objects. Default: false.

When false, such scan-only pages cause an error to be thrown. When true, such pages are skipped and conversion continues.

table_format

PDF2MdSettingData.TableFormat foxit.addon.conversion.pdf2md.PDF2MdSettingData.table_format

getset

Table output format. Default value: .

Please refer to values starting from foxit.addon.conversion.pdf2md.PDF2MdSettingData.TableFormat.e_TableFormatMarkdown and this should be one of these values.