foxit.addon.conversion.md2pdf.Md2PDF Class Reference

Inherits SystemIDisposable.

Static Public Member Functions
static bool	ConvertFromMarkdown (string src_markdown_file_path, string src_file_password, string saved_pdf_path, Md2PDFSettingData setting_data)
	Convert a Markdown format file to a PDF file. More...
static string	GetVersion ()
	Get the version of Foxit PDF Conversion SDK. More...
static void	Initialize (string library_path)
	Initialize the Md2PDF module by loading the Foxit PDF Conversion SDK library. More...
static void	Release ()
	Release the Md2PDF module and unload the Foxit PDF Conversion SDK library. More...

Detailed Description

This class can be used to convert Markdown format files to PDF files.

Note

Before using this class, please call Md2PDF.Initialize to load the Foxit PDF Conversion SDK library. After all conversions are done, call Md2PDF.Release to unload the library.

Member Function Documentation

ConvertFromMarkdown()

static bool foxit.addon.conversion.md2pdf.Md2PDF.ConvertFromMarkdown ( string  src_markdown_file_path, string  src_file_password, string  saved_pdf_path, Md2PDFSettingData  setting_data  )

inlinestatic

Convert a Markdown format file to a PDF file.

Function Md2PDF.Initialize must be called successfully before calling this function.

Parameters

[in]	src_markdown_file_path	Path of a Markdown format file. This should not be an empty string.
[in]	src_file_password	(Reserved) Password for the input file. Please pass an empty string.
[in]	saved_pdf_path	Path of the saved PDF file as conversion result. This should not be an empty string.
[in]	setting_data	A Md2PDFSettingData object which is used for converting. Default value: Md2PDFSettingData default values.

Returns

true means success, while false means failure.

GetVersion()

static string foxit.addon.conversion.md2pdf.Md2PDF.GetVersion ( )

inlinestatic

Get the version of Foxit PDF Conversion SDK.

This function should be called after the function Md2PDF.Initialize has been called successfully.

Returns

A string which contains the version information of Foxit PDF Conversion SDK.

Initialize()

static void foxit.addon.conversion.md2pdf.Md2PDF.Initialize ( string  library_path )

inlinestatic

Initialize the Md2PDF module by loading the Foxit PDF Conversion SDK library.

Before using Md2PDF.ConvertFromMarkdown , please call this function first with the path to the Foxit PDF Conversion SDK library. Function common.Library.Initialize must already have been called successfully with a key including "Md2PDF" module right.

Parameters

[in]

library_path

Path to the Foxit PDF Conversion SDK dynamic library (e.g. "fpdfconversionsdk_win64.dll" on Windows, "libfpdfconversionsdk.so" on Linux). This should not be an empty string.

Returns

None.

Release()

static void foxit.addon.conversion.md2pdf.Md2PDF.Release ( )

inlinestatic

Release the Md2PDF module and unload the Foxit PDF Conversion SDK library.

This function should be called after all Md2PDF.ConvertFromMarkdown calls are finished. It must be called after Md2PDF.Initialize has been called successfully.

Returns

None.