Foxit PDF SDK
类方法 | 所有成员列表
FSConvert类 参考
类 FSConvert 继承关系图:
FSBase

类方法

(BOOL) + fromDWG:src_dwg_path:saved_pdf_path:settings:
 将DWG格式文件转换为PDF文件。
更多...
 
(void) + fromHTML:engine_path:cookies_path:setting_data:saved_pdf_path:timeout:
 将HTML格式文件或网页URL转换为PDF文件。
更多...
 
(void) + fromHTMLWithReaderCallback:engine_path:cookies_reader:setting_data:saved_pdf_path:timeout:
 将HTML格式文件或网页URL转换为PDF文件。
更多...
 
(void) + fromHTMLWithReaderCallbackHTML:html2pdf_related_resource_array:engine_path:cookies_reader:setting_data:saved_pdf_filestream:timeout:
 将HTML格式文件或网页URL转换为PDF文件。
更多...
 
(void) + fromHTMLWithSaveFileWriterCallback:engine_path:cookies_reader:setting_data:saved_pdf_filestream:timeout:
 将HTML格式文件或网页URL转换为PDF文件。
更多...
 
(void) + fromImage:saved_pdf_path:
 将图像格式文件转换为PDF文件。
更多...
 
(void) + fromImageWithStreamCallback:saved_pdf_filestream:
 将图像格式文件转换为PDF文件。
更多...
 
(void) + fromTXT:saved_pdf_path:setting_data:
 将TXT格式文件转换为PDF文件。
更多...
 
(BOOL) + toXML:src_file_password:saved_xml_path:saved_image_folder_path:is_force_to_tagged_pdf:
 将PDF文件转换为XML格式文件。
更多...
 

详细描述

转换插件模块可用于PDF文件与其他文件格式之间的转换。 在使用此模块中的任何类或方法之前，请确保函数 FSLibrary::initialize:key: 使用包含 "Conversion" 模块的密钥成功初始化。 在使用函数 FSConvert::fromDWG:src_dwg_path:saved_pdf_path:settings: 之前，请确保 FSLibrary::initialize:key: 使用包含 "DWG2PDF" 模块的密钥成功初始化。 从版本11.0开始，我们不再更新和维护linux x86平台上的HTML2PDF引擎包，在未来版本中可能会在linux x86平台上弃用。

参见
FSLibrary

函数文档

◆ fromDWG:src_dwg_path:saved_pdf_path:settings:()

+ (BOOL) fromDWG: (NSString *)  engine_path
src_dwg_path: (NSString *)  src_dwg_path
saved_pdf_path: (NSString *)  saved_pdf_path
settings: (FSDWG2PDFSettingData*)  settings 

将DWG格式文件转换为PDF文件。

目前，此函数只能在桌面平台上使用；对于其他平台，此函数将 直接返回NO而不执行任何操作。

参数
[in]engine_path"DWG到PDF"引擎的目录路径。这不应该是空字符串。
[in]src_dwg_pathDWG或DXF格式文件路径。这不应该是空字符串。
[in]saved_pdf_path保存转换后PDF文件的路径。这不应该是空字符串。
[in]settings用于转换的 FSDWG2PDFSettingData 对象。
返回
YES 代表成功，而 NO 代表失败。

◆ fromHTML:engine_path:cookies_path:setting_data:saved_pdf_path:timeout:()

+ (void) fromHTML: (NSString *)  src_html
engine_path: (NSString *)  engine_path
cookies_path: (NSString *)  cookies_path
setting_data: (FSHTML2PDFSettingData*)  setting_data
saved_pdf_path: (NSString *)  saved_pdf_path
timeout: (int)  timeout 

将HTML格式文件或网页URL转换为PDF文件。

目前，此函数只能在桌面平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。

参数
[in]src_html网页URL或HTML格式文件路径。这不应该是空字符串。
[in]engine_path"HTML到PDF"引擎的目录路径。这不应该是空字符串。
[in]cookies_pathCookie文件的路径。如果这是空字符串，表示不使用Cookie文件。 强烈建议使用JSON格式的数据格式。
[in]setting_data用于转换的设置数据。
[in]saved_pdf_path保存转换后PDF文件的路径。这不应该是空字符串。
[in]timeout用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
返回
无。

◆ fromHTMLWithReaderCallback:engine_path:cookies_reader:setting_data:saved_pdf_path:timeout:()

+ (void) fromHTMLWithReaderCallback: (NSString *)  src_html
engine_path: (NSString *)  engine_path
cookies_reader: (id<FSFileReaderCallback>)  cookies_reader
setting_data: (FSHTML2PDFSettingData*)  setting_data
saved_pdf_path: (NSString *)  saved_pdf_path
timeout: (int)  timeout 

将HTML格式文件或网页URL转换为PDF文件。

目前，此函数只能在桌面平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。

参数
[in]src_html网页URL或HTML格式文件路径。这不应该是空字符串。
[in]engine_path"HTML到PDF"引擎的目录路径。这不应该是空字符串。
[in]cookies_reader用户实现的 FSFileReaderCallback 对象， 用于向Foxit PDF SDK传递cookie数据。如果这是nil，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。
[in]setting_data用于转换的设置数据。
[in]saved_pdf_path保存转换后PDF文件的路径。这不应该是空字符串。
[in]timeout用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
返回
无。

◆ fromHTMLWithReaderCallbackHTML:html2pdf_related_resource_array:engine_path:cookies_reader:setting_data:saved_pdf_filestream:timeout:()

+ (void) fromHTMLWithReaderCallbackHTML: (id<FSFileReaderCallback>)  src_html
html2pdf_related_resource_array: (FSHTML2PDFRelatedResourceArray*)  html2pdf_related_resource_array
engine_path: (NSString *)  engine_path
cookies_reader: (id<FSFileReaderCallback>)  cookies_reader
setting_data: (FSHTML2PDFSettingData*)  setting_data
saved_pdf_filestream: (id<FSFileWriterCallback>)  saved_pdf_filestream
timeout: (int)  timeout 

将HTML格式文件或网页URL转换为PDF文件。

目前，此函数只能在桌面平台和mac arm平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。

参数
[in]html2pdf_related_resource_array与源HTML相关的 FSHTML2PDFRelatedResourceArray 。
[in]engine_path"HTML到PDF"引擎的目录路径。这不应该是空字符串。
[in]cookies_reader（保留；尚未支持）用户实现的 FSFileReaderCallback 对象， 用于向Foxit PDF SDK传递cookie数据。如果这是nil，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。
[in]setting_data用于转换的设置数据。
[in]saved_pdf_filestream用于保存转换后PDF文件的 FSFileWriterCallback 对象。这不应该是nil。
[in]timeout用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
返回
无。

◆ fromHTMLWithSaveFileWriterCallback:engine_path:cookies_reader:setting_data:saved_pdf_filestream:timeout:()

+ (void) fromHTMLWithSaveFileWriterCallback: (NSString *)  src_html
engine_path: (NSString *)  engine_path
cookies_reader: (id<FSFileReaderCallback>)  cookies_reader
setting_data: (FSHTML2PDFSettingData*)  setting_data
saved_pdf_filestream: (id<FSFileWriterCallback>)  saved_pdf_filestream
timeout: (int)  timeout 

将HTML格式文件或网页URL转换为PDF文件。

目前，此函数只能在桌面平台上使用；对于其他平台，此函数将 直接返回而不执行任何操作。

参数
[in]src_html网页URL或HTML格式文件路径。这不应该是空字符串。
[in]engine_path"HTML到PDF"引擎的目录路径。这不应该是空字符串。
[in]cookies_reader用户实现的 FSFileReaderCallback 对象， 用于向Foxit PDF SDK传递cookie数据。如果这是nil，表示不使用cookie数据。 强烈建议使用JSON格式的数据格式。
[in]setting_data用于转换的设置数据。
[in]saved_pdf_filestream用于保存转换后PDF文件的 FSFileWriterCallback 对象。这不应该是nil。
[in]timeout用于加载网页的超时秒数。应该设置为大于15的值。 如果小于15，将默认使用15。
返回
无。

◆ fromImage:saved_pdf_path:()

+ (void) fromImage: (NSString *)  src_img
saved_pdf_path: (NSString *)  saved_pdf_path 

将图像格式文件转换为PDF文件。

参数
[in]src_img图像格式文件路径。这不应该是空字符串。
[in]saved_pdf_path保存转换后PDF文件的路径。这不应该是空字符串。
返回
无。

◆ fromImageWithStreamCallback:saved_pdf_filestream:()

+ (void) fromImageWithStreamCallback: (id<FSFileReaderCallback>)  file_reader
saved_pdf_filestream: (id<FSFileWriterCallback>)  saved_pdf_filestream 

将图像格式文件转换为PDF文件。

参数
[in]file_reader用户实现的 FSFileReaderCallback 对象， 用于向Foxit PDF SDK传递图像数据。必须是有效的。
[in]saved_pdf_filestream用于保存转换后PDF文件的 FSFileWriterCallback 对象。 这不应该是nil。
返回
无。

◆ fromTXT:saved_pdf_path:setting_data:()

+ (void) fromTXT: (NSString *)  src_txt
saved_pdf_path: (NSString *)  saved_pdf_path
setting_data: (FSTXT2PDFSettingData*)  setting_data 

将TXT格式文件转换为PDF文件。

参数
[in]src_txtTXT格式文件路径。这不应该是空字符串。
[in]saved_pdf_path保存转换后PDF文件的路径。这不应该是空字符串。
[in]setting_data用于转换的设置数据。
返回
无。

◆ toXML:src_file_password:saved_xml_path:saved_image_folder_path:is_force_to_tagged_pdf:()

+ (BOOL) toXML: (NSString *)  src_pdf_path
src_file_password: (NSString *)  src_file_password
saved_xml_path: (NSString *)  saved_xml_path
saved_image_folder_path: (NSString *)  saved_image_folder_path
is_force_to_tagged_pdf: (BOOL)  is_force_to_tagged_pdf 

将PDF文件转换为XML格式文件。

参数
[in]src_pdf_pathPDF文件的路径。这不应该是空字符串。
[in]src_file_password输入PDF文件的密码。如果文件不需要密码，请传递空字符串。
[in]saved_xml_path保存作为转换结果的XML格式文件的路径。这不应该是空字符串。
[in]saved_image_folder_path指定用于在转换过程中生成图像文件的文件夹路径。 如果这是空字符串，图像文件将生成到名为"images"的文件夹中（如果不存在， Foxit PDF SDK将默认生成此类文件夹）。文件夹"images"将与保存的XML格式文件 （参数saved_xml_path）位于同一目录中。
[in]is_force_to_tagged_pdf（仅在输入PDF文件不是标记PDF文件时有用） 布尔值，用于决定当输入PDF文件不是标记PDF时，是否允许将输入PDF文件转换为标记PDF：
  • YES表示输入PDF文件（尚未标记PDF）将首先转换为标记PDF。 然后标记PDF将转换为XML格式文件。
  • NO表示不允许将输入PDF文件（尚未标记PDF）转换为标记PDF。 在这种情况下，输入PDF文件不会转换为XML格式文件，此函数将返回NO。

返回
YES表示成功，NO表示失败。