fpdfconversionsdk.PDF2MdSettingData Class Reference

Public Member Functions
def	GetEnable_bold ()
	Get whether to preserve bold formatting from the original PDF. More...
def	GetEnable_italic ()
	Get whether to preserve italic formatting from the original PDF. More...
def	GetInclude_header_footer ()
	Get whether to include page header/footer (artifact) content. More...
def	GetSkip_ocr_pages ()
	Get whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR). More...
def	GetTable_format ()
	Get table output format. More...
def	SetEnable_bold (value)
	Set whether to preserve bold formatting from the original PDF. More...
def	SetEnable_italic (value)
	Set whether to preserve italic formatting from the original PDF. More...
def	SetInclude_header_footer (value)
	Set whether to include page header/footer (artifact) content. More...
def	SetSkip_ocr_pages (value)
	Set whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR). More...
def	SetTable_format (value)
	Set table output format. More...

Detailed Description

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

Member Function Documentation

GetEnable_bold()

fpdfconversionsdk.PDF2MdSettingData.GetEnable_bold

(

)

Get whether to preserve bold formatting from the original PDF.

Returns

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.

GetEnable_italic()

fpdfconversionsdk.PDF2MdSettingData.GetEnable_italic

(

)

Get whether to preserve italic formatting from the original PDF.

Returns

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.

GetInclude_header_footer()

fpdfconversionsdk.PDF2MdSettingData.GetInclude_header_footer

(

)

Get whether to include page header/footer (artifact) content.

Returns

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

GetSkip_ocr_pages()

fpdfconversionsdk.PDF2MdSettingData.GetSkip_ocr_pages

(

)

Get whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR).

Returns

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 to be thrown. When true, such pages are skipped and conversion continues.

GetTable_format()

fpdfconversionsdk.PDF2MdSettingData.GetTable_format

(

)

Get table output format.

Returns

Table output format. Default value: .

SetEnable_bold()

fpdfconversionsdk.PDF2MdSettingData.SetEnable_bold

(

value

)

Set whether to preserve bold formatting from the original PDF.

Parameters

[in]

value

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.

Returns

None.

SetEnable_italic()

fpdfconversionsdk.PDF2MdSettingData.SetEnable_italic

(

value

)

Set whether to preserve italic formatting from the original PDF.

Parameters

[in]

value

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.

Returns

None.

SetInclude_header_footer()

fpdfconversionsdk.PDF2MdSettingData.SetInclude_header_footer

(

value

)

Set whether to include page header/footer (artifact) content.

Parameters

[in]

value

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

Returns

None.

SetSkip_ocr_pages()

fpdfconversionsdk.PDF2MdSettingData.SetSkip_ocr_pages

(

value

)

Set whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR).

Parameters

[in]

value

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 to be thrown. When true, such pages are skipped and conversion continues.

Returns

None.

SetTable_format()

fpdfconversionsdk.PDF2MdSettingData.SetTable_format

(

value

)

Set table output format.

Parameters

[in]

value

Table output format. Default value: .

Returns

None.