com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData Class Reference

Public Member Functions
	PDF2MdSettingData ()
	Constructor.
	PDF2MdSettingData (int table_format, boolean include_header_footer, boolean enable_italic, boolean enable_bold, boolean skip_ocr_pages)
	Constructor, with parameters. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
boolean	getEnable_bold ()
	Get whether to preserve bold formatting from the original PDF. More...
boolean	getEnable_italic ()
	Get whether to preserve italic formatting from the original PDF. More...
boolean	getInclude_header_footer ()
	Get whether to include page header/footer (artifact) content. More...
boolean	getSkip_ocr_pages ()
	Get whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR). More...
int	getTable_format ()
	Get table output format. More...
void	setEnable_bold (boolean value)
	Set whether to preserve bold formatting from the original PDF. More...
void	setEnable_italic (boolean value)
	Set whether to preserve italic formatting from the original PDF. More...
void	setInclude_header_footer (boolean value)
	Set whether to include page header/footer (artifact) content. More...
void	setSkip_ocr_pages (boolean value)
	Set whether to silently skip pages that contain only path/image objects (scan-only pages that would normally require OCR). More...
void	setTable_format (int value)
	Set table output format. More...

Static Public Attributes
static final int	e_TableFormatHTML = 1
	Table format: HTML table tags.
static final int	e_TableFormatMarkdown = 0
	Table format: Markdown pipe syntax (default).

Detailed Description

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

Constructor & Destructor Documentation

PDF2MdSettingData()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.PDF2MdSettingData	(	int	table_format,
		boolean	include_header_footer,
		boolean	enable_italic,
		boolean	enable_bold,
		boolean	skip_ocr_pages
	)

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 instead of throwing . Default: false.

Member Function Documentation

delete()

synchronized void com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.delete

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

Once this function is called, current object cannot be used anymore.

getEnable_bold()

com.foxit.sdk.conversion.pdf2md.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()

com.foxit.sdk.conversion.pdf2md.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()

com.foxit.sdk.conversion.pdf2md.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()

com.foxit.sdk.conversion.pdf2md.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()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.getTable_format

(

)

Get table output format.

Returns

Table output format. Default value: .

setEnable_bold()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.setEnable_bold

(

boolean

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()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.setEnable_italic

(

boolean

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()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.setInclude_header_footer

(

boolean

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()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.setSkip_ocr_pages

(

boolean

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()

com.foxit.sdk.conversion.pdf2md.PDF2MdSettingData.setTable_format

(

int

value

)

Set table output format.

Parameters

[in]

value

Table output format. Default value: .

Returns

None.