Foxit PDF Conversion SDK
PDFConversionSDK.PDF2Md Class Reference

Static Public Member Functions

static ConvertToMarkdown (src_pdf_file_path, src_file_password, saved_md_path, saved_image_dir_name?, setting_data?)
 Convert a PDF file to a Markdown file. More...
 

Detailed Description

This class can be used to convert PDF files to Markdown files. Before using methods in this module, please ensure Foxit PDF Conversion SDK has been initialized successfully by function Library.Initialize with a key including "PDF2Office" module.

See also
Library

Member Function Documentation

◆ ConvertToMarkdown()

static PDFConversionSDK.PDF2Md.ConvertToMarkdown (   src_pdf_file_path,
  src_file_password,
  saved_md_path,
  saved_image_dir_name?,
  setting_data? 
)
inlinestatic

Convert a PDF file to a Markdown file.

Parameters
[in]src_pdf_file_pathPath of a PDF file. This should not be an empty string.
[in]src_file_passwordPassword for the input PDF file. If no password is needed for the file, please pass an empty string.
[in]saved_md_pathPath of the saved Markdown file as conversion result. This should not be an empty string.
[in]saved_image_dir_nameName of the directory for saving images extracted from the PDF file. This directory will be created under the same folder as the output Markdown file. Default value: an empty string which means no images will be extracted.
[in]setting_dataA PDFConversionSDK.PDF2MdSettingData object which is used for converting. Default value: NULL which means no setting data is provided and default settings will be used.
Returns
true means success, while false means failure.
Note
If module "PDF2Office" is not defined in the license information which is used in function Library.Initialize, that means user has no right in using this function and this function will throw exception PDFConversionSDK.e_ErrNoPDF2OfficeModuleRight.