|
Foxit PDF SDK
|
静态 Public 成员函数 | |
| static | AddExternalFontPath (font_path) |
| 添加外部字体路径。 更多... | |
| static | EnableJavaScript (enable_javascript) |
| 启用或禁用 PDF 的 JavaScript。 更多... | |
| static | EnableThreadSafety (is_enable_thread_safety) |
| 启用线程安全性。 更多... | |
| static | ExecuteJavaScript (java_script) |
| 执行 JavaScript。 更多... | |
| static | FlushLog () |
| 刷新日志文件。 更多... | |
| static | GetRenderConfig () |
| 获取渲染配置。 更多... | |
| static | GetVersion () |
| 获取当前 Foxit PDF SDK 库的版本。 更多... | |
| static | HasModuleLicenseRight (module_name) |
| 检查用户是否有权在当前使用的许可证信息(用于初始化 Foxit PDF SDK)中使用 Foxit PDF SDK 的指定模块。 更多... | |
| static | Initialize (sn, key) |
| 使用有效的许可证信息初始化 Foxit PDF SDK 库。 更多... | |
| static | Initialize (sn, key, is_optimize_memory, enable_js_xfa_threadsafety) |
| 使用有效的许可证信息初始化 Foxit PDF SDK 库。 更多... | |
| static | InitializeOFDEngine (ofd_library_path) |
| 初始化 OFD 引擎。 更多... | |
| static | MatchExternalFontsOnly (only_match) |
| 指定是否仅从外部字体匹配字体。 更多... | |
| static | RegisterSecurityCallback (filter, callback) |
| 将 FSDK.SecurityCallback 对象注册到 Foxit PDF SDK,用于解密具有特殊加密过滤器的 PDF。 更多... | |
| static | RegisterSignatureCallback (filter, sub_filter, signature_callback) |
| 将第三方 FSDK.SignatureCallback 对象连同其过滤器和子过滤器名称一起注册到 Foxit PDF SDK,用于签名和验证签名。 更多... | |
| static | RegisterXFAAppProviderCallback (callback) |
| 将 FSDK.AppProviderCallback 对象注册到 Foxit PDF SDK。 更多... | |
| static | Reinitialize () |
| 重新初始化 Foxit PDF SDK 库。 更多... | |
| static | Release () |
| 释放 Foxit PDF SDK 库分配的所有资源。 更多... | |
| static | ReleaseOFDEngine () |
| 释放 OFD 引擎。 更多... | |
| static | SetActionCallback (action_callback) |
| 将 FSDK.ActionCallback 对象设置到 Foxit PDF SDK,以帮助执行 PDF 操作。 更多... | |
| static | SetAnnotIconProviderCallback (annot_icon_provider) |
| 将自定义的 FSDK.IconProviderCallback 对象设置到 Foxit PDF SDK。 更多... | |
| static | SetCacheSize (size) |
| 设置 PDF 库缓存大小的上限。 更多... | |
| static | SetDefaultICCProfilesPath (icc_profile_folder_path) |
| 设置包含默认 ICC 配置文件的文件夹路径。 更多... | |
| static | SetDocEventCallback (callback) |
| 将 FSDK.DocEventCallback 对象设置到 Foxit PDF SDK。 更多... | |
| static | SetFontMapperCallback (callback) |
| 将 FSDK.FontMapperCallback 对象设置到 Foxit PDF SDK。 更多... | |
| static | SetLogFile (log_file_path) |
| 设置日志文件路径。 更多... | |
| static | SetLogFile (log_file_path) |
| 设置日志文件路径。 更多... | |
| static | SetLogFile (log_file) |
| 设置日志文件流。 更多... | |
| static | SetNotifierCallback (notifier) |
| 将 FSDK.NotifierCallback 对象设置到 Foxit PDF SDK。 更多... | |
| static | SetRenderConfig (render_config) |
| 设置渲染配置。 更多... | |
| static | SetRenderTextGamma (gamma) |
| 为文本渲染设置伽马值。 更多... | |
| static | SetTimeStampCallback (timestamp_callback) |
| 将 FSDK.TimeStampCallback 对象设置到 Foxit PDF SDK,以帮助与时间戳服务器交互。 更多... | |
| static | UnregisterSecurityCallback (filter) |
| 从 Foxit PDF SDK 中注销 FSDK.SecurityCallback 对象。 更多... | |
| static | UnregisterSignatureCallback (filter, sub_filter) |
| 从 Foxit PDF SDK 中注销与特定过滤器和子过滤器关联的第三方 FSDK.SignatureCallback 对象。 如果默认签名可用,它将与其过滤器和子过滤器值一起被恢复。 更多... | |
此类表示库管理。 它包含用于初始化/重新初始化/释放 Foxit PDF SDK 库的函数,也包含用于 全局使用的函数。
任何应用程序在调用任何其他 Foxit PDF SDK 函数之前,应通过函数 FSDK.Library.Initialize 加载 Foxit PDF SDK。 当不再需要使用 Foxit PDF SDK 时,请调用 函数 FSDK.Library.Release。
Foxit PDF SDK 中的函数在发生错误时可能会抛出异常。用户可以捕获这些异常并 检查错误代码(从 FSDK.e_ErrFile 开始的值)以了解发生了什么错误。
|
static |
添加外部字体路径。
| [in] | font_path | 外部字体路径。 |
|
static |
启用或禁用 PDF 的 JavaScript。
PDF 的 JavaScript 默认为启用。
| [in] | enable_javascript | true 表示启用 JavaScript,false 表示禁用 JavaScript。 如果未调用此函数,PDF 的 JavaScript 默认为启用。 |
|
static |
启用线程安全性。
目前,模块 "OCR" 不支持线程安全性。
| [in] | is_enable_thread_safety | 启用线程安全性。true 表示启用线程安全性, 而 false 表示禁用线程安全性。 |
|
static |
执行 JavaScript。
| [in] | java_script | 需要执行的 JavaScript。 |
|
static |
刷新日志文件。
|
static |
获取渲染配置。
|
static |
获取当前 Foxit PDF SDK 库的版本。
|
static |
检查用户是否有权在当前使用的许可证信息(用于初始化 Foxit PDF SDK)中使用 Foxit PDF SDK 的指定模块。
在 Foxit PDF SDK 中,一旦库成功初始化,大多数功能都可以使用。 但对于某些特殊功能,只有在许可证信息中定义了指定模块时才能使用它们。 此函数可用于在使用这些功能之前检查用户是否有权使用这些特殊模块。
| [in] | module_name | 要检查其权限的模块名称。请参阅从 FSDK.e_ModuleNameConnectedPDF 开始的值, 并且应为这些值之一。 |
|
static |
使用有效的许可证信息初始化 Foxit PDF SDK 库。
在应用程序的生命周期中,此函数只能被调用一次,并且 应在 Foxit PDF SDK 中的任何其他函数被调用之前首先调用。
一旦调用了函数 FSDK.Library.Release,在应用程序的生命周期内 就无法再初始化 Foxit PDF SDK 库了。
| [in] | sn | SN 信息字符串,可以从密钥文件"gsdk_sn.txt"或"rdk_sn.txt"中的"SN="部分获取。 |
| [in] | key | 密钥信息字符串,可以从密钥文件"gsdk_key.txt"或"rdk_key.txt"中的"Sign="部分获取。 |
|
static |
使用有效的许可证信息初始化 Foxit PDF SDK 库。
在应用程序的生命周期中,此函数只能调用一次,并且应在调用 Foxit PDF SDK 中的任何其他函数之前首先调用。
一旦调用了函数 FSDK.Library.Release,则在应用程序的生命周期中无法再初始化 Foxit PDF SDK 库。
| [in] | sn | SN 信息的字符串,可以从密钥文件 "gsdk_sn.txt" 或 "rdk_sn.txt" 中的 "SN=" 部分检索。 |
| [in] | key | 密钥信息的字符串,可以从密钥文件 "gsdk_key.txt" 或 "rdk_key.txt" 中的 "Sign=" 部分检索。 |
| [in] | is_optimize_memory | 该标志用于尝试通过清理内存碎片来优化内存。 true 表示清理内存碎片,false 表示不清理。 |
| [in] | enable_js_xfa_threadsafety | 该标志用于启用 JavaScript 和 XFA 模块的线程安全性。 true 表示启用,false 表示不启用。默认值为 false。 用户需要确保一个 PDF 文档一次只能由一个线程操作。 |
|
static |
初始化 OFD 引擎。
在使用 OFD 模块中的任何其他函数之前必须调用此函数。 在使用 OFD 模块之前,请确保 OFD 包中名为 "lib" 的资源文件夹有效。 在初始化 OFD 引擎并使用此模块中的任何类或方法之前,请确保 Foxti PDF SDK 已通过函数 FSDK.Library.Initialize 使用包含 "OFD" 模块的密钥成功初始化。
目前,OFD 模块仅支持 Windows 和 Linux64 系统。
| [in] | ofd_library_path | OFD 库的路径。此参数不应为空字符串。 |
|
static |
指定是否仅从外部字体匹配字体。
| [in] | only_match | true 表示仅匹配通过函数 AddExternalFontPath 添加的外部字体。 false 表示当找不到外部字体时匹配系统字体。 默认值为 false。 |
|
static |
将 FSDK.SecurityCallback 对象注册到 Foxit PDF SDK,用于解密具有特殊加密过滤器的 PDF。
当此函数成功时,Foxit PDF SDK 将接管输入的安全回调对象,用户不应再直接释放此回调对象; 否则可能在后续发生意外崩溃。
当注销安全回调对象并发现它未被其他对象使用时,Foxit PDF SDK 可能会通过回调函数 FSDK.SecurityCallback.Release 释放安全回调对象。因此,建议用户在调用函数 FSDK.Library.UnregisterSecurityCallback 后不再使用该安全回调对象。
| [in] | filter | 安全回调对象的过滤器名称。此参数不应为 null 或空字符串。 当用户实现 FSDK.CustomSecurityCallback 的安全回调时, 用户可以指定自己的自定义过滤器字符串,但需要遵循 PDF 名称约定。 当用户实现 FSDK.CertificateSecurityCallback 的安全回调时, 过滤器值必须设置为 "Adobe.PubSec"。 当用户实现 FSDK.DRMSecurityCallback 的安全回调时, 过滤器值必须设置为 "FoxitDRM",否则可能在后续发生错误。 当用户实现 FSDK.RMSSecurityCallback 的安全回调时, 过滤器值必须设置为 "MicrosoftIRMServices" 或 "FoxitRMS",否则可能在后续发生错误。 |
| [in] | callback | 由用户实现并基于回调类 FSDK.SecurityCallback 的 FSDK.SecurityCallback 对象。 用户不应直接继承 FSDK.SecurityCallback,而应继承其派生类, 如 FSDK.CustomSecurityCallback、FSDK.CertificateSecurityCallback 等。 |
|
static |
将第三方 FSDK.SignatureCallback 对象连同其过滤器和子过滤器名称一起注册到 Foxit PDF SDK,用于签名和验证签名。
Foxit PDF SDK 具有使用过滤器和子过滤器定义的默认签名回调:
如果用户想要使用第三方签名回调,请在签名或验证签名过程之前调用此函数。
如果用户通过此函数注册一个与默认签名回调具有相同过滤器和子过滤器的自定义签名回调, 并且参数 signature_callback 的值不为 null,Foxit PDF SDK 中的默认签名回调将不生效。 如果用户通过此函数注册一个与默认签名回调具有相同过滤器和子过滤器的自定义签名回调, 并且参数 signature_callback 的值为 null,Foxit PDF SDK 中的默认签名回调将再次生效。
| [in] | filter | 签名回调的过滤器名称,以 ASCII 编码。 此参数不应为空字符串。 过滤器名称是签名回调的名称。 |
| [in] | sub_filter | 签名回调的子过滤器名称,以 ASCII 编码。 子过滤器用于描述签名字典中签名值和密钥信息的编码。 |
| [in] | signature_callback | 由用户实现并基于回调类 FSDK.SignatureCallback 的自定义 FSDK.SignatureCallback 对象。 用户应确保所有回调函数已在应用程序层实现,并且还应确保此签名回调对象有效, 直到 Foxit PDF SDK 被函数 FSDK.Library.Release 释放。 如果此参数为 null,则表示将从 Foxit PDF SDK 中移除已注册的第三方回调。 |
|
static |
将 FSDK.AppProviderCallback 对象注册到 Foxit PDF SDK。
在处理 XFA 文档之前应首先调用此函数。
| [in] | callback | 由用户实现并基于回调类 FSDK.AppProviderCallback 的 FSDK.AppProviderCallback 对象。 用户应确保所有回调函数已在应用程序层实现,并且还应确保此 XFA 应用程序提供程序回调对象有效, 直到 Foxit PDF SDK 被函数 FSDK.Library.Release 释放。 |
|
static |
重新初始化 Foxit PDF SDK 库。
当用户遇到内存不足错误或用户想要在调用函数 FSDK.Library.Release 之前重新初始化 Foxit PDF SDK 库时, 用户可以调用此函数来重新初始化 Foxit PDF SDK 库。
一旦调用了函数 FSDK.Library.Release,则在应用程序的生命周期中无法再初始化 Foxit PDF SDK 库。
|
static |
释放 Foxit PDF SDK 库分配的所有资源。
用户应调用此函数来释放库分配的所有内存块。
一旦调用此函数,则在应用程序的生命周期中无法再初始化 Foxit PDF SDK 库。
|
static |
释放 OFD 引擎。
当在 Foxit PDF SDK 被释放之前不再需要使用 OFD 引擎时,可以调用此函数来释放它。
|
static |
将 FSDK.ActionCallback 对象设置到 Foxit PDF SDK,以帮助执行 PDF 操作。
如果需要执行 PDF 操作(例如填写 PDF 表单),用户应实现一个操作回调对象并调用此函数将操作回调对象设置到 Foxit PDF SDK。
| [in] | action_callback | 一个自定义的 FSDK.ActionCallback 对象。null 表示不使用任何操作回调对象。 用户应确保所有回调函数已在应用程序层实现。如果此参数为有效的操作回调对象, Foxit PDF SDK 将接管此回调对象的管理,用户不应直接释放它。 |
|
static |
将自定义的 FSDK.IconProviderCallback 对象设置到 Foxit PDF SDK。
用户可以调用此函数为注释设置自定义图标提供程序。 如果多次调用此函数,Foxit PDF SDK 将只保留最后一个图标提供程序。 如果从未调用过此函数,Foxit PDF SDK 将使用默认的标准图标提供程序。
| [in] | annot_icon_provider | 一个自定义的注释图标提供程序,基于回调类 FSDK.IconProviderCallback 实现。 如果此参数为 null,则将从 Foxit PDF SDK 中移除自定义注释图标提供程序, 并将使用默认的标准图标提供程序。应用程序应确保此图标提供程序对象有效, 直到它从 Foxit PDF SDK 中被移除或调用函数 FSDK.Library.Release。 |
|
static |
设置 PDF 库缓存大小的上限。
如果应用程序未设置缓存大小限制,缓存大小将默认在内部设置为 200 兆字节。
| [in] | size | 缓存的上限,以兆字节为单位,0~4096。 如果设置为 0,则表示不使用缓存大小限制。 |
|
static |
设置包含默认 ICC 配置文件的文件夹路径。
默认的 ICC 配置文件在 Foxit PDF SDK 包的 "res" 文件夹中提供。默认的 ICC 配置文件是 "sRGB Color Space Profile.icm"、"sGray.icc" 和 "USWebCoatedSWOP.icc"。Foxit PDF SDK 将 从输入的文件夹路径加载这些默认的 ICC 配置文件。
如果输入的文件夹路径不存在或默认的 ICC 配置文件未全部在指定的文件夹中, 此函数将抛出 FSDK.e_ErrFilePathNotExist。
| [in] | icc_profile_folder_path | 包含默认 ICC 配置文件的有效文件夹路径。 |
|
static |
将 FSDK.DocEventCallback 对象设置到 Foxit PDF SDK。
| [in] | callback | 一个 FSDK.DocEventCallback 对象。 null 表示不使用任何文档事件回调对象。 |
|
static |
将 FSDK.FontMapperCallback 对象设置到 Foxit PDF SDK。
一旦将有效的自定义字体映射器回调设置到 Foxit PDF SDK,Foxit PDF SDK 将在映射字体时首先使用此回调。
| [in] | callback | 一个 FSDK.FontMapperCallback 对象。 null 表示不使用任何自定义字体映射器回调对象。 |
|
static |
设置日志文件路径。
将日志文件路径设置到 Foxit PDF SDK 后,所有日志将被写入日志文件。 目前,Foxit PDF SDK 中的日志信息较为简单;这将在未来的版本中改进。
| [in] | log_file_path | 日志文件路径。 |
|
static |
设置日志文件路径。
将日志文件路径设置到 Foxit PDF SDK 后,所有日志将被写入日志文件。 目前,Foxit PDF SDK 中的日志信息较为简单;这将在未来的版本中改进。
| [in] | log_file_path | 日志文件路径。 |
|
static |
设置日志文件流。
将日志文件设置到 Foxit PDF SDK 后,所有日志将被写入日志文件流。 目前,Foxit PDF SDK 中的日志信息较为简单;这将在未来的版本中改进。
| [in] | log_file | 日志文件流。 |
|
static |
将 FSDK.NotifierCallback 对象设置到 Foxit PDF SDK。
用户可以调用此函数将通知器回调对象设置到 Foxit PDF SDK, 这样当事件(如 OOM)发生时,用户将收到通知。
| [in] | notifier | 一个 FSDK.NotifierCallback 对象。用户应确保所有回调函数已在应用程序层实现。 |
|
static |
设置渲染配置。
| [in] | render_config | 要设置的渲染配置对象。 |
|
static |
为文本渲染设置伽马值。
如果未调用此函数设置伽马值,Foxit PDF SDK 将使用 2.2 作为默认值。
| [in] | gamma | 伽马值。应大于 0。 |
|
static |
将 FSDK.TimeStampCallback 对象设置到 Foxit PDF SDK,以帮助与时间戳服务器交互。
当此函数成功时,Foxit PDF SDK 将接管签名期间的默认时间戳交互,用户不应再直接释放此回调对象; 否则可能在后续发生意外崩溃。
当 timestamp_callback 为 null 时,Foxit PDF SDK 可能会通过回调函数 FSDK.TimeStampCallback.Release 释放时间戳回调对象。
| [in] | timestamp_callback | 由用户实现并基于回调类 FSDK.TimeStampCallback 的自定义 FSDK.TimeStampCallback 对象。 用户应确保所有回调函数已在应用程序层实现,并且还应确保此时间戳回调对象有效, 直到 Foxit PDF SDK 被函数 FSDK.Library.Release 释放。 如果此参数为 null,则表示将从 Foxit PDF SDK 中移除已注册的第三方回调。 |
|
static |
从 Foxit PDF SDK 中注销 FSDK.SecurityCallback 对象。
当注销安全回调对象并发现它未被其他对象使用时,Foxit PDF SDK 可能会通过回调函数 FSDK.SecurityCallback.Release 释放安全回调对象。因此,建议用户在调用函数 FSDK.Library.UnregisterSecurityCallback 后不再使用该安全回调对象。
| [in] | filter | 用于注册安全回调对象的过滤器名称。 请参阅函数 FSDK.Library.RegisterSecurityCallback 中参数 filter 的注释。 |
|
static |
从 Foxit PDF SDK 中注销与特定过滤器和子过滤器关联的第三方 FSDK.SignatureCallback 对象。 如果默认签名可用,它将与其过滤器和子过滤器值一起被恢复。
Foxit PDF SDK 具有使用过滤器和子过滤器定义的默认签名回调:
| [in] | filter | 签名回调的过滤器名称,以 ASCII 编码。 此参数不应为空字符串。 过滤器名称是签名回调的名称。 |
| [in] | sub_filter | 签名回调的子过滤器名称,以 ASCII 编码。 子过滤器用于描述签名字典中签名值和密钥信息的编码。 |