Foxit PDF SDK

静态 Public 成员函数 | 所有成员列表
foxit.addon.ocr.OCREngine类 参考

继承自 SystemIDisposable .

## 静态 Public 成员函数
static ErrorCode | Initialize (string ocr_resource_path)
| 初始化OCR引擎。 更多...
static ErrorCode | Initialize (string ocr_resource_path, bool is_shared_cpu_cores_mode)
| 初始化OCR引擎。 更多...
static void | Release ()
| 释放OCR引擎。 更多...
static void | SetLanguages (string languages)
| 设置要包含在语言数据库中进行OCR识别的语言名称。 更多...
static void | SetLogFile (string log_file_path)
| 为OCR引擎设置日志文件。 更多...
static void | SetOCRCallback (OCRCallback callback)
| 设置用于取消OCR进度的回调对象。 更多...

## 详细描述

OCR附加模块可用于将图像的文本内容转换为PDF页面或PDF文档中的可搜索文本或可编辑文本。 使用OCR模块之前，用户应首先准备OCR资源文件夹，如"Foxit PDF SDK Developer Guide.pdf"文档中所述。 在初始化OCR引擎和使用此模块中的任何类或方法之前，请确保 Foxit PDF SDK已通过函数 common.Library.Initialize 使用包含"OCR"模块的密钥成功初始化。
目前，OCR模块仅支持Windows和Linux64系统。

参见
  foxit.common.Library

## 成员函数说明

## ◆ Initialize() [1/2]

static ErrorCode foxit.addon.ocr.OCREngine.Initialize | ( | string | ocr_resource_path | ) |
| inline static

初始化OCR引擎。

这应该在OCR附加模块中任何其他方法之前成功调用。

参数

  [in] | ocr_resource_path | OCR资源文件夹的文件路径。它不应该是空字符串。 请参考"Foxit PDF SDK Developer Guide.pdf"文档了解更多详情。

注解
  如果在函数 common.Library.Initialize 中使用的许可证信息中未定义模块"OCR"， 这意味着用户无权使用OCR相关功能，此构造函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOCRModuleRight 。

返回
  foxit.common.ErrorCode.e_ErrSuccess 表示成功。
  foxit.common.ErrorCode.e_ErrNoOCRModuleRight 表示Foxit PDF SDK未使用 包含"OCR"模块的密钥初始化。
  foxit.common.ErrorCode.e_ErrParam 表示参数 ocrt_resource_path 是空字符串。
  有关错误代码值的更多信息，请参考从 foxit.common.ErrorCode.e_ErrSuccess 开始的值。

## ◆ Initialize() [2/2]

static ErrorCode foxit.addon.ocr.OCREngine.Initialize | ( | string | ocr_resource_path,
|  | bool | is_shared_cpu_cores_mode
| ) |  |
| inline static

初始化OCR引擎。

这应该在OCR附加模块中任何其他方法之前成功调用。

参数

  [in] | ocr_resource_path | OCR资源文件夹的文件路径。它不应该是空字符串。 请参考"Foxit PDF SDK Developer Guide.pdf"文档了解更多详情。
  [in] | is_shared_cpu_cores_mode | 布尔值，指定是否应在共享模式下使用CPU核心。 CPU核心使用有两种模式：独立和共享。在独立模式下，OCR引擎 使用的进程数不超过许可证允许的数量。在共享模式下，可以运行任意数量的 进程。 true 表示CPU核心应在共享模式下使用，而 false 表示不使用。 在多进程模式下，强烈建议将此参数设置为 true， 例如调用函数 OCR.OCRPDFDocuments 。 在单进程模式下，此参数应设置为 false。 默认值：false。

注解
  如果在函数 common.Library.Initialize 中使用的许可证信息中未定义模块"OCR"， 这意味着用户无权使用OCR相关功能，此构造函数将抛出异常 foxit.common.ErrorCode.e_ErrNoOCRModuleRight 。

返回
  foxit.common.ErrorCode.e_ErrSuccess 表示成功。
  foxit.common.ErrorCode.e_ErrNoOCRModuleRight 表示Foxit PDF SDK未使用 包含"OCR"模块的密钥初始化。
  foxit.common.ErrorCode.e_ErrParam 表示参数 ocrt_resource_path 是空字符串。
  有关错误代码值的更多信息，请参考从 foxit.common.ErrorCode.e_ErrSuccess 开始的值。

## ◆ Release()

static void foxit.addon.ocr.OCREngine.Release | ( |  | ) |
| inline static

释放OCR引擎。

在不再需要使用OCR引擎时，在Foxit PDF SDK释放之前，可以调用此函数来释放OCR引擎。

返回
  无返回值。

## ◆ SetLanguages()

static void foxit.addon.ocr.OCREngine.SetLanguages | ( | string | languages | ) |
| inline static

设置要包含在语言数据库中进行OCR识别的语言名称。

当前支持的语言：

- 当使用CJK语言资源时，支持简体中文、繁体中文、日语、韩语。

- 当使用其他语言资源时，支持巴斯克语、保加利亚语、加泰罗尼亚语、克罗地亚语、捷克语、 丹麦语、荷兰语、英语、爱沙尼亚语、法罗语、芬兰语、法语、加利西亚语、德语、希腊语、 希伯来语、匈牙利语、冰岛语、意大利语、拉脱维亚语、立陶宛语、马其顿语、马耳他语、 挪威语、波兰语、葡萄牙语、罗马尼亚语、俄语、塞尔维亚语、斯洛伐克语、斯洛文尼亚语、 西班牙语、瑞典语、泰语、土耳其语、乌克兰语、阿拉伯语。

如果没有通过此函数设置任何语言，Foxit PDF SDK将默认使用"English"。

参数

  [in] | languages | 语言名称。这不应该是空字符串。 这可以包含一个语言名称或用逗号分隔的多个语言名称。 例如，"English"表示仅英语，"English,French"表示仅英语和法语。

返回
  无返回值。

## ◆ SetLogFile()

static void foxit.addon.ocr.OCREngine.SetLogFile | ( | string | log_file_path | ) |
| inline static

为OCR引擎设置日志文件。

此函数用于为OCR引擎设置日志文件，而不是为Foxit PDF SDK设置。 如果用户想为Foxit PDF SDK设置日志文件，请参考函数 common.Library.SetLogFile 。

参数

  [in] | log_file_path | 日志文件路径。如果这是空字符串，则表示停止OCR引擎的日志。

返回
  无返回值。

## ◆ SetOCRCallback()

static void foxit.addon.ocr.OCREngine.SetOCRCallback | ( | OCRCallback | callback | ) |
| inline static

设置用于取消OCR进度的回调对象。

参数

  [in] | callback | 基于回调类 OCRCallback 实现的自定义OCR回调。 null 表示不使用任何OCR回调对象。用户应确保所有回调函数 都已在应用程序级别实现。

返回
  无返回值。