|
Foxit PDF Conversion SDK
|
fpdfconversionsdk命名空间。 更多...
类 | |
| class | Base |
| class | ConvertCallback |
| class | ConvertCheckCallback |
| class | Excel2PDFSettingData |
| class | Library |
| class | Office2PDF |
| class | Office2PDFSettingData |
| class | PDF2ExcelSettingData |
| class | PDF2Office |
| class | PDF2OfficeSettingData |
| class | PDF2PowerPointSettingData |
| class | PDF2WordSettingData |
| class | Progressive |
| class | Range |
| class | Word2PDFSettingData |
| class | WStringArray |
函数 | |
| def | LibraryEnableThreadSafety () |
| 启用线程安全。 更多... | |
| def | LibraryGetVersion () |
| 获取当前Foxit PDF Conversion SDK库的版本。 更多... | |
| def | LibraryInitialize () |
| 使用有效的许可证信息初始化Foxit PDF Conversion SDK库。 更多... | |
| def | LibraryReinitialize () |
| 重新初始化Foxit PDF Conversion SDK库。 更多... | |
| def | LibraryRelease () |
| 释放Foxit PDF Conversion SDK库分配的所有资源。 更多... | |
| def | LibrarySetConvertCheckCallback () |
| 设置回调对象以检查PDF到Office转换的条件。 更多... | |
| def | Office2PDFConvertFromExcel () |
| 将Excel格式文件转换为PDF文件。 更多... | |
| def | Office2PDFConvertFromPowerPoint () |
| 将PowerPoint格式文件转换为PDF文件。 更多... | |
| def | Office2PDFConvertFromWord () |
| 将Word格式文件转换为PDF文件。 更多... | |
| def | PDF2OfficeStartConvertToExcel () |
| 开始将PDF文件转换为Excel格式文件。 更多... | |
| def | PDF2OfficeStartConvertToPowerPoint () |
| 开始将PDF文件转换为PowerPoint格式文件。 更多... | |
| def | PDF2OfficeStartConvertToWord () |
| 开始将PDF文件转换为Word格式文件。 更多... | |
变量 | |
| E_ErrCertificate | |
| 证书错误:PDF文档由数字证书加密 但当前用户没有正确的证书。 | |
| E_ErrDataNotReady | |
| 数据未就绪。通常,这在以异步方式加载文档时 用作异常错误代码。 | |
| E_ErrFile | |
| 找不到文件或无法打开文件。 | |
| E_ErrFormat | |
| 格式无效。对于文件,这也可能意味着文件已损坏。 | |
| E_ErrHandle | |
| 句柄错误。 | |
| E_ErrInvalidLicense | |
| 使用无效许可证初始化Foxit PDF Conversion SDK库。 | |
| E_ErrInvalidType | |
| 输入对象或当前对象的类型无效。 | |
| E_ErrNoDocumentPermission | |
| 无文档操作权限。 | |
| E_ErrNoOffice2PDFModuleRight | |
| 无"Office2PDF"模块权限。 | |
| E_ErrNoPDF2OfficeModuleRight | |
| 无"PDF2Office"模块权限。 | |
| E_ErrNotFound | |
| 找不到预期的数据或对象。 | |
| E_ErrNotLoaded | |
| 当前对象尚未加载。 | |
| E_ErrNotMatchFont | |
| 字体不匹配。 | |
| E_ErrNotParsed | |
| 内容尚未解析。通常,这表示PDF页面尚未解析。 | |
| E_ErrOutOfMemory | |
| 发生内存不足错误。 | |
| E_ErrParam | |
| 参数错误:函数的任何输入参数的值无效。 | |
| E_ErrPassword | |
| 密码无效。通常,此错误可能在使用密码加载PDF文档时发生。 遇到此错误时,用户应使用正确的密码重新加载文档。 | |
| E_ErrSecurityHandler | |
| PDF文档由某些不受支持的安全处理程序加密。 | |
| E_ErrSuccess | |
| 成功,未发生错误。 | |
| E_ErrUnknown | |
| 发生任何未知错误。 | |
| E_ErrUnknownState | |
| 发生任何未知状态。 | |
| E_ErrUnsupported | |
| 不支持某些类型。 | |
| E_PermAnnotForm | |
| 操作文本注释并填写交互式表单字段。(权限值的第6位) 更多... | |
| E_PermAssemble | |
| 组装PDF文档。(权限值的第11位) 更多... | |
| E_PermExtract | |
| 提取PDF内容。(权限值的第5位) 更多... | |
| E_PermExtractAccess | |
| 辅助功能支持。(权限值的第10位) 更多... | |
| E_PermFillForm | |
| 填写PDF表单。(权限值的第9位) 更多... | |
| E_PermModify | |
| 修改PDF内容。(权限值的第4位) 更多... | |
| E_PermPrint | |
| 以普通模式打印PDF文档。(权限值的第3位) 更多... | |
| E_PermPrintHigh | |
| 以更高质量打印PDF文档。(权限值的第12位) 更多... | |
| PDF2ExcelSettingDataE_WorkbookSettingsDocument | |
| 为文档创建单个工作表。 | |
| PDF2ExcelSettingDataE_WorkbookSettingsEachPage | |
| 为每个页面创建工作表。 | |
| PDF2ExcelSettingDataE_WorkbookSettingsEachTable | |
| 为每个表格创建工作表。 | |
| ProgressiveE_Error | |
| 进度状态:发生任何错误。 | |
| ProgressiveE_Finished | |
| 进度状态:进度已完成。 | |
| ProgressiveE_ToBeContinued | |
| 进度状态:进度需要继续。 | |
| RangeE_All | |
| 将使用范围内的所有索引。 | |
| RangeE_Even | |
| 将仅使用范围内的偶数(丢弃奇数)。 | |
| RangeE_Odd | |
| 将仅使用范围内的奇数(丢弃偶数)。 | |
fpdfconversionsdk命名空间。
| def fpdfconversionsdk.LibraryEnableThreadSafety | ( | ) |
启用线程安全。
| [in] | is_enable_thread_safety | 启用线程安全。true 表示启用线程安全, 而 false 表示禁用线程安全。 |
| def fpdfconversionsdk.LibraryGetVersion | ( | ) |
获取当前Foxit PDF Conversion SDK库的版本。
| def fpdfconversionsdk.LibraryInitialize | ( | ) |
使用有效的许可证信息初始化Foxit PDF Conversion SDK库。
在应用程序的生命周期中,此函数只能调用一次, 并且应在调用Foxit PDF Conversion SDK中的任何其他函数之前首先调用。
一旦调用了函数 fpdfconversionsdk.LibraryRelease ,在应用程序的生命周期中 就不能再初始化Foxit PDF Conversion SDK库了。
| [in] | sn | sn信息字符串,可以从密钥文件"gsdk_sn.txt"或"rdk_sn.txt"中的"SN="部分检索。 |
| [in] | key | 密钥信息字符串,可以从密钥文件"gsdk_key.txt"或"rdk_key.txt"中的"Sign="部分检索。 |
| def fpdfconversionsdk.LibraryReinitialize | ( | ) |
重新初始化Foxit PDF Conversion SDK库。
当用户遇到内存不足错误或用户想要在调用函数 fpdfconversionsdk.LibraryRelease 之前 重新初始化Foxit PDF Conversion SDK库时,用户可以调用此函数来重新初始化Foxit PDF Conversion SDK库。
一旦调用了函数 fpdfconversionsdk.LibraryRelease ,在应用程序的生命周期中 就不能再初始化Foxit PDF Conversion SDK库了。
| def fpdfconversionsdk.LibraryRelease | ( | ) |
释放Foxit PDF Conversion SDK库分配的所有资源。
用户应调用此函数来释放库分配的所有内存块。
一旦调用了此函数,在应用程序的生命周期中 就不能再初始化Foxit PDF Conversion SDK库了。
| def fpdfconversionsdk.LibrarySetConvertCheckCallback | ( | ) |
设置回调对象以检查PDF到Office转换的条件。
此方法允许您指定一个自定义的转换检查回调,当转换PDF文档所需的权限不满足时, 将调用该回调来评估是否应继续从PDF到Office的转换,基于用户自定义的逻辑。
| [in] | convert_check_callback | 基于回调类 fpdfconversionsdk.ConvertCheckCallback 实现的自定义转换检查回调。 如果为 null,将移除自定义转换检查回调,并使用默认的转换检查。 |
| def fpdfconversionsdk.Office2PDFConvertFromExcel | ( | ) |
将Excel格式文件转换为PDF文件。
目前,此函数仅适用于Windows和Linux桌面(32位和64位),仅支持从XLSX格式文件转换。
| [in] | src_excel_file_path | Excel格式文件的路径。此参数不应为空字符串。 |
| [in] | src_file_password | (保留,尚不支持加密文件)输入Excel格式文件的密码。如果文件不需要密码, 请传递空字符串。 |
| [in] | saved_pdf_path | 作为转换结果保存的PDF文件路径。此参数不应为空字符串。 |
| [in] | setting_data | 用于转换的 fpdfconversionsdk.Office2PDFSettingData 对象。 |
目前,此函数仅适用于Windows和Linux桌面(32位和64位),仅支持从XLSX格式文件转换。 文件一次性全部读取,而不是逐步读取。
| [in] | src_excel_reader | 由用户实现的 FileReaderCallback 对象,用于 加载Excel文档。此参数不应为null。 |
| [in] | src_file_password | (保留,尚不支持加密文件)输入Word格式文件的密码。如果文件不需要密码, 请传递空字符串。 |
| [in] | saved_pdf_file_stream | 由用户实现的 fsdk.StreamCallback 对象, 用于读取转换后的PDF文件的内容。此参数不应为null。 |
| [in] | setting_data | 用于转换的 fpdfconversionsdk.Office2PDFSettingData 对象。 |
| def fpdfconversionsdk.Office2PDFConvertFromPowerPoint | ( | ) |
将PowerPoint格式文件转换为PDF文件。
目前,此函数仅适用于Windows和Linux桌面(32位和64位),仅支持从PPTX格式文件转换。
| [in] | src_ppt_file_path | PowerPoint格式文件的路径。此参数不应为空字符串。 |
| [in] | src_file_password | (保留,尚不支持加密文件)输入Excel格式文件的密码。如果文件不需要密码, 请传递空字符串。 |
| [in] | saved_pdf_path | 作为转换结果保存的PDF文件路径。此参数不应为空字符串。 |
| [in] | setting_data | 用于转换的 fpdfconversionsdk.Office2PDFSettingData 对象。 |
目前,此函数仅适用于Windows和Linux桌面(32位和64位),仅支持从PPTX格式文件转换。 文件一次性全部读取,而不是逐步读取。
| [in] | src_ppt_reader | 由用户实现的 FileReaderCallback 对象,用于 加载PowerPoint文档。此参数不应为null。 |
| [in] | src_file_password | (保留,尚不支持加密文件)输入Word格式文件的密码。如果文件不需要密码, 请传递空字符串。 |
| [in] | saved_pdf_file_stream | 由用户实现的 fsdk.StreamCallback 对象, 用于读取转换后的PDF文件的内容。此参数不应为null。 |
| [in] | setting_data | 用于转换的 fpdfconversionsdk.Office2PDFSettingData 对象。 |
| def fpdfconversionsdk.Office2PDFConvertFromWord | ( | ) |
将Word格式文件转换为PDF文件。
目前,此函数仅适用于Windows和Linux桌面(32位和64位),仅支持从DOC和DOCX格式文件转换。
| [in] | src_word_file_path | Word格式文件的路径。此参数不应为空字符串。 |
| [in] | src_file_password | (保留,尚不支持加密文件)输入Word格式文件的密码。如果文件不需要密码, 请传递空字符串。 |
| [in] | saved_pdf_path | 作为转换结果保存的PDF文件路径。此参数不应为空字符串。 |
| [in] | setting_data | 用于转换的 fpdfconversionsdk.Office2PDFSettingData 对象。 |
目前,此函数仅适用于Windows和Linux桌面(32位和64位),仅支持从DOC和DOCX格式文件转换。 文件一次性全部读取,而不是逐步读取。
| [in] | src_word_reader | 由用户实现的 FileReaderCallback 对象,用于 加载Word文档。此参数不应为null。 |
| [in] | src_file_password | (保留,尚不支持加密文件)输入Word格式文件的密码。如果文件不需要密码, 请传递空字符串。 |
| [in] | saved_pdf_file_stream | 由用户实现的 fsdk.StreamCallback 对象, 用于读取转换后的PDF文件的内容。此参数不应为null。 |
| [in] | setting_data | 用于转换的 fpdfconversionsdk.Office2PDFSettingData 对象。 |
| def fpdfconversionsdk.PDF2OfficeStartConvertToExcel | ( | ) |
开始将PDF文件转换为Excel格式文件。
目前仅支持转换为XLSX格式文件。
| [in] | src_pdf_path | PDF文件的路径。不应为空字符串。 |
| [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码,请传递空字符串。 |
| [in] | saved_excel_file_path | 作为转换结果保存的Excel格式文件的路径。不应为空字符串。 如果保存的Excel格式文件的后缀名不是"xlsx",则会将新的后缀名"xlsx"添加到原始文件名。 |
| [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空,则表示将PDF文件的每一页转换为Word格式文件。 |
| [in] | convert_callback | 由用户实现的 fpdfconversionsdk.ConvertCallback 对象, 用于在转换过程中暂停和通知转换进度。 这可以为 null,表示不暂停和通知转换进度。 如果不为 null,则应为由用户实现的有效 fpdfconversionsdk.ConvertCallback 对象。 默认值:null。 |
目前仅支持转换为XLSX格式文件。
| [in] | src_pdf_reader | 由用户实现的 FileReaderCallback 对象, 用于加载PDF文档。不应为 null。 |
| [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码,请传递空字符串。 |
| [in] | saved_excel_file_stream | 由用户实现的 fsdk.StreamCallback 对象, 用于读取转换后的Excel格式文件的内容。不应为 null。 |
| [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空,则表示将PDF文件的每一页转换为Word格式文件。 |
| [in] | convert_callback | 由用户实现的 fpdfconversionsdk.ConvertCallback 对象, 用于在转换过程中暂停和通知转换进度。 这可以为 null,表示不暂停和通知转换进度。 如果不为 null,则应为由用户实现的有效 fpdfconversionsdk.ConvertCallback 对象。 默认值:null。 |
| def fpdfconversionsdk.PDF2OfficeStartConvertToPowerPoint | ( | ) |
开始将PDF文件转换为PowerPoint格式文件。
目前仅支持转换为PPTX格式文件。
| [in] | src_pdf_path | PDF文件的路径。不应为空字符串。 |
| [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码,请传递空字符串。 |
| [in] | saved_ppt_file_path | 作为转换结果保存的PowerPoint格式文件的路径。不应为空字符串。 如果保存的PowerPoint格式文件的后缀名不是"pptx",则会将新的后缀名"pptx"添加到原始文件名。 |
| [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空,则表示将PDF文件的每一页转换为Word格式文件。 |
| [in] | convert_callback | 由用户实现的 fpdfconversionsdk.ConvertCallback 对象, 用于在转换过程中暂停和通知转换进度。 这可以为 null,表示不暂停和通知转换进度。 如果不为 null,则应为由用户实现的有效 fpdfconversionsdk.ConvertCallback 对象。 默认值:null。 |
目前仅支持转换为PPTX格式文件。
| [in] | src_pdf_reader | 由用户实现的 FileReaderCallback 对象, 用于加载PDF文档。不应为 null。 |
| [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码,请传递空字符串。 |
| [in] | saved_ppt_file_stream | 由用户实现的 fsdk.StreamCallback 对象, 用于读取转换后的PowerPoint格式文件的内容。不应为 null。 |
| [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空,则表示将PDF文件的每一页转换为Word格式文件。 |
| [in] | convert_callback | 由用户实现的 fpdfconversionsdk.ConvertCallback 对象, 用于在转换过程中暂停和通知转换进度。 这可以为 null,表示不暂停和通知转换进度。 如果不为 null,则应为由用户实现的有效 fpdfconversionsdk.ConvertCallback 对象。 默认值:null。 |
| def fpdfconversionsdk.PDF2OfficeStartConvertToWord | ( | ) |
开始将PDF文件转换为Word格式文件。
目前仅支持转换为DOCX格式文件。此函数支持识别PDF文档中的标题并 将其转换为Word文档。目前,标题转换仍处于测试阶段,将在后续版本中进一步改进。
| [in] | src_pdf_path | PDF文件的路径。不应为空字符串。 |
| [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码,请传递空字符串。 |
| [in] | saved_word_file_path | 作为转换结果保存的Word格式文件的路径。不应为空字符串。 如果保存的Word格式文件的后缀名不是"docx",则会将新的后缀名"docx"添加到原始文件名。 |
| [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空,则表示将PDF文件的每一页转换为Word格式文件。 |
| [in] | convert_callback | 由用户实现的 fpdfconversionsdk.ConvertCallback 对象, 用于在转换过程中暂停和通知转换进度。 这可以为 null,表示不暂停和通知转换进度。 如果不为 null,则应为由用户实现的有效 fpdfconversionsdk.ConvertCallback 对象。 默认值:null。 |
目前仅支持转换为DOCX格式文件。此函数支持识别PDF文档中的标题并 将其转换为Word文档。目前,标题转换仍处于测试阶段,将在后续版本中进一步改进。
| [in] | src_pdf_reader | 由用户实现的 FileReaderCallback 对象, 用于加载PDF文档。不应为 null。 |
| [in] | src_pdf_password | 输入PDF文件的密码。如果文件不需要密码,请传递空字符串。 |
| [in] | saved_word_file_stream | 由用户实现的 fsdk.StreamCallback 对象, 用于读取转换后的Word格式文件的内容。不应为 null。 |
| [in] | setting_data | 用于转换的设置数据。如果 PDF2OfficeSettingData 对象的参数 page_range 为空,则表示将PDF文件的每一页转换为Word格式文件。 |
| [in] | convert_callback | 由用户实现的 fpdfconversionsdk.ConvertCallback 对象, 用于在转换过程中暂停和通知转换进度。 这可以为 null,表示不暂停和通知转换进度。 如果不为 null,则应为由用户实现的有效 fpdfconversionsdk.ConvertCallback 对象。 默认值:null。 |
| fpdfconversionsdk.E_PermAnnotForm |
操作文本注释并填写交互式表单字段。(权限值的第6位)
如果还设置了值 , 用户可以创建或修改交互式表单字段(包括签名字段)。
| fpdfconversionsdk.E_PermAssemble |
组装PDF文档。(权限值的第11位)
如果设置了此值,则可以组装文档 (插入、旋转或删除页面,创建书签或缩略图), 无论是否设置了值 。
| fpdfconversionsdk.E_PermExtract |
提取PDF内容。(权限值的第5位)
如果设置了此值,用户可以通过除由值 控制的操作之外的操作 从文档中复制或提取文本和图形。
| fpdfconversionsdk.E_PermExtractAccess |
辅助功能支持。(权限值的第10位)
如果设置了此值,用户可以提取文本和图形以支持 残障用户的辅助功能或其他目的。
| fpdfconversionsdk.E_PermFillForm |
填写PDF表单。(权限值的第9位)
如果设置了此值,用户可以填写交互式表单字段(包括签名字段), 即使未使用值 。
| fpdfconversionsdk.E_PermModify |
修改PDF内容。(权限值的第4位)
如果设置了此值,用户可以通过除由值 、 和 控制的操作之外的操作来修改PDF文档的内容。
| fpdfconversionsdk.E_PermPrint |
以普通模式打印PDF文档。(权限值的第3位)
如果用户想要打印更高质量的PDF文档,请将此值与 值 一起设置。
| fpdfconversionsdk.E_PermPrintHigh |
以更高质量打印PDF文档。(权限值的第12位)
如果未设置此值(且设置了值 ), 打印将限制为低级别的外观表示,可能质量下降。