fsdk.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. More...
def	GetTable_format ()
	Get table output format. More...
def	Set (table_format, include_header_footer, enable_italic, enable_bold, skip_ocr_pages)
	Set value. 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. 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()

fsdk.PDF2MdSettingData.GetEnable_bold

(

)

Get 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, bold formatting is stripped.

Returns

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

GetEnable_italic()

fsdk.PDF2MdSettingData.GetEnable_italic

(

)

Get whether to preserve italic formatting from the original PDF.

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

Returns

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

GetInclude_header_footer()

fsdk.PDF2MdSettingData.GetInclude_header_footer

(

)

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

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

Returns

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

GetSkip_ocr_pages()

fsdk.PDF2MdSettingData.GetSkip_ocr_pages

(

)

Get whether to silently skip pages that contain only path/image objects.

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

Returns

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

GetTable_format()

fsdk.PDF2MdSettingData.GetTable_format

(

)

Get table output format.

Please refer to values starting from fsdk.PDF2MdSettingDataE_TableFormatMarkdown and this should be one of these values.

Returns

Table output format. Default value: .

Set()

def fsdk.PDF2MdSettingData.Set	(		table_format,
			include_header_footer,
			enable_italic,
			enable_bold,
			skip_ocr_pages
	)

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.

SetEnable_bold()

fsdk.PDF2MdSettingData.SetEnable_bold

(

value

)

Set 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, bold formatting is stripped.

Parameters

[in]

value

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

Returns

None.

SetEnable_italic()

fsdk.PDF2MdSettingData.SetEnable_italic

(

value

)

Set whether to preserve italic formatting from the original PDF.

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

Parameters

[in]

value

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

Returns

None.

SetInclude_header_footer()

fsdk.PDF2MdSettingData.SetInclude_header_footer

(

value

)

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

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

Parameters

[in]

value

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

Returns

None.

SetSkip_ocr_pages()

fsdk.PDF2MdSettingData.SetSkip_ocr_pages

(

value

)

Set whether to silently skip pages that contain only path/image objects.

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

Parameters

[in]

value

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

Returns

None.

SetTable_format()

fsdk.PDF2MdSettingData.SetTable_format

(

value

)

Set table output format.

Please refer to values starting from fsdk.PDF2MdSettingDataE_TableFormatMarkdown and this should be one of these values.

Parameters

[in]

value

Table output format. Default value: .

Returns

None.