Foxit PDF SDK
FoxitPDFSDKPython3.Convert Class Reference
Inheritance diagram for FoxitPDFSDKPython3.Convert:
FoxitPDFSDKPython3.Base

Static Public Member Functions

def FromDWG (engine_path, src_dwg_path, saved_pdf_path, settings)
 Convert a DWG format file to a PDF file.
More...
 
def FromHTML (src_html, engine_path, cookies_path, setting_data, saved_pdf_path, timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file.
More...
 
def FromHTML (src_html, engine_path, cookies_reader, setting_data, saved_pdf_filestream, timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file.
More...
 
def FromHTML (src_html, engine_path, cookies_reader, setting_data, saved_pdf_path, timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file.
More...
 
def FromHTML (src_html, html2pdf_related_resource_array, engine_path, cookies_reader, setting_data, saved_pdf_filestream, timeout)
 Convert a HTML format file or a URL of a Web page to a PDF file.
More...
 
def FromImage (src_img, saved_pdf_path)
 Convert a Image format file to a PDF file.
More...
 
def FromTXT (src_txt, saved_pdf_path, setting_data)
 Convert a TXT format file to a PDF file.
More...
 
def ToXML (src_pdf_path, src_file_password, saved_xml_path, saved_image_folder_path, is_force_to_tagged_pdf)
 Convert a PDF file to a XML format file.
More...
 

Detailed Description

Conversion add-on module can be used to do some conversion between PDF file and other file formats. Before using "Conversion" module, user should first prepare font resource folder as described in "Foxit PDF SDK Developer Guide.pdf" document. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython3.Library.Initialize with a key including "Conversion" module. Before using function FoxitPDFSDKPython3.Convert.FromDWG , please ensure Foxit PDF SDK has been initialized successfully by function FoxitPDFSDKPython3.Library.Initialize with a key including "DWG2PDF" module.

See also
FoxitPDFSDKPython3.Library

Member Function Documentation

◆ FromDWG()

FoxitPDFSDKPython3.Convert.FromDWG (   engine_path,
  src_dwg_path,
  saved_pdf_path,
  settings 
)
static

Convert a DWG format file to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return false directly without doing anything.

Parameters
[in]engine_pathThe directory path of "DWG to PDF" engine. This should not be an empty string.
[in]src_dwg_pathA DWG or DXF format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]settingsThe DWG2PDFSettingData object used for converting.
Returns
None.

◆ FromHTML() [1/4]

FoxitPDFSDKPython3.Convert.FromHTML (   src_html,
  engine_path,
  cookies_path,
  setting_data,
  saved_pdf_path,
  timeout 
)
static

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_pathPath of cookies file. If this is an empty string, that means no cookie file is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

◆ FromHTML() [2/4]

FoxitPDFSDKPython3.Convert.FromHTML (   src_html,
  engine_path,
  cookies_reader,
  setting_data,
  saved_pdf_filestream,
  timeout 
)
static

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_readerA FoxitPDFSDKPython3.FileReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is null, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_filestreamA FoxitPDFSDKPython3.FileWriterCallback object for saving the converted PDF file. This should not be null.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

◆ FromHTML() [3/4]

FoxitPDFSDKPython3.Convert.FromHTML (   src_html,
  engine_path,
  cookies_reader,
  setting_data,
  saved_pdf_path,
  timeout 
)
static

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA URL of Web page or a HTML format file path. This should not be an empty string.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_readerA FoxitPDFSDKPython3.FileReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is null, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

◆ FromHTML() [4/4]

FoxitPDFSDKPython3.Convert.FromHTML (   src_html,
  html2pdf_related_resource_array,
  engine_path,
  cookies_reader,
  setting_data,
  saved_pdf_filestream,
  timeout 
)
static

Convert a HTML format file or a URL of a Web page to a PDF file.

Currently, this function can only be used for desktop platforms and mac arm platforms; for other platform, this function will return directly without doing anything.

Parameters
[in]src_htmlA FoxitPDFSDKPython3.FileReaderCallback object which is implemented by user to pass html data to Foxit PDF SDK. It must be vaild.
[in]html2pdf_related_resource_arrayThe HTML2PDFRelatedResourceArray which is related to source HTML.
[in]engine_pathThe directory path of "HTML to PDF" engine. This should not be an empty string.
[in]cookies_reader(Reserved;Not supported yet)A FoxitPDFSDKPython3.FileReaderCallback object which is implemented by user to pass cookies data to Foxit PDF SDK. If this is null, that means no cookie data is used. Data format is strongly recommended to use JSON format.
[in]setting_dataSetting data used for converting.
[in]saved_pdf_filestreamA FoxitPDFSDKPython3.FileWriterCallback object for saving the converted PDF file. This should not be null.
[in]timeoutSeconds for timeout used for loading web pages. It should be set to a value greater than 15. If this is less than 15, 15 will be used by default.
Returns
None.

◆ FromImage()

FoxitPDFSDKPython3.Convert.FromImage (   src_img,
  saved_pdf_path 
)
static

Convert a Image format file to a PDF file.

Parameters
[in]src_imgA image format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
Returns
None.
Parameters
[in]file_readerA FoxitPDFSDKPython3.FileReaderCallback object which is implemented by user to pass image data to Foxit PDF SDK. It must be valid.
[in]saved_pdf_filestreamA FoxitPDFSDKPython3.FileWriterCallback object for saving the converted PDF file. This should not be null.
Returns
None.

◆ FromTXT()

FoxitPDFSDKPython3.Convert.FromTXT (   src_txt,
  saved_pdf_path,
  setting_data 
)
static

Convert a TXT format file to a PDF file.

Parameters
[in]src_txtA TXT format file path. This should not be an empty string.
[in]saved_pdf_pathA path for saving the converted PDF file. This should not be an empty string.
[in]setting_dataSetting data used for converting.
Returns
None.

◆ ToXML()

FoxitPDFSDKPython3.Convert.ToXML (   src_pdf_path,
  src_file_password,
  saved_xml_path,
  saved_image_folder_path,
  is_force_to_tagged_pdf 
)
static

Convert a PDF file to a XML format file.

Parameters
[in]src_pdf_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_xml_pathPath of the saved XML format file as conversion result. This should not be an empty string.
[in]saved_image_folder_pathA path to specify a folder where image files will be generated during the converting. If this is an empty string, image files will be generated to a folder named "images" (if not exist, Foxit PDF SDK will generate such folder by default). Folder "images" would be in the same directory with saved XML format file (as parameter saved_xml_path).
[in]is_force_to_tagged_pdf(Only useful when input PDF file is not a tagged PDF file) A boolean value to decide whether input PDF file is allowed to be converted to a tagged PDF when input PDF file is not a tagged PDF:
  • true means input PDF file (which is not tagged PDF yet) will first be converted to a tagged PDF. Then the tagged PDF will be converted to a XML format file.
  • false means not allow to convert input PDF file (which is not tagged PDF yet) to a tagged PDF. In this case, input PDF file will not be converted to XML format file and this function will return false.

Returns
true means success, while false means failure.