Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::FullTextSearch类 参考

## Public 成员函数
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| SearchOf (match_string, rank_mode, callback)
| 在索引的 PDF 文件中搜索指定的文本。 更多...
| SetDataBasePath (path_of_data_base)
| 设置一个文件路径作为 sqlite 数据库，用于存储索引数据。 更多...
| StartUpdateIndex (source, pause, reupdate)
| 开始更新文档源对象中定义的 PDF 文件的索引。 更多...
| UpdateIndexWithFilePath (file_path)
| 更新指定 PDF 文件的索引结果。 更多...

## 静态 Public 属性
static | e_RankNone: number static e_RankHitCountASC: number static e_RankHitCountDESC: number constructor()
| 全文搜索的排序模式枚举。 更多...

## 详细描述

此类用于索引一些 PDF 文件，然后在这些索引的 PDF 文件中搜索指定的文本。

## 成员函数说明

## ◆ IsEmpty()

FSDK::FullTextSearch::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  true 表示当前对象为空，而 false 表示不是。

## ◆ SearchOf()

FSDK::FullTextSearch::SearchOf | ( | match_string | ,
|  | rank_mode | ,
|  | callback |
| ) |  |

在索引的 PDF 文件中搜索指定的文本。

此函数可用于在多个 PDF 文件中进行搜索，这些文件已通过函数 FSDK.FullTextSearch.StartUpdateIndex 或 FSDK.FullTextSearch.UpdateIndexWithFilePath 进行索引。 搜索结果将通过回调函数 FSDK.SearchCallback.RetrieveSearchResult 以指定的排序模式返回。

参数

  [in] | match_string | 要搜索的字符串。它不应为空字符串，并且应为 UTF-8 编码。
  [in] | rank_mode | 用于搜索结果的排序模式。请参考从 FSDK.FullTextSearch.e_RankNone 开始的值，这应该是这些值之一。
  [in] | callback | FSDK.SearchCallback 对象。它不应为 null。 用户应实现它并使用它来检索搜索结果。

返回
  true 表示成功，而 false 表示失败。

## ◆ SetDataBasePath()

FSDK::FullTextSearch::SetDataBasePath | ( | path_of_data_base |  | ) |

设置一个文件路径作为 sqlite 数据库，用于存储索引数据。

此函数仅在通过函数 FSDK.FullTextSearch.StartUpdateIndex 或 FSDK.FullTextSearch.UpdateIndexWithFilePath 首次更新 PDF 文件的索引之前有用。 一旦更新完成，此函数将无用。
如果从未为当前全文搜索对象成功调用此函数，则 sqlite 数据的默认文件 将命名为"fts.db"并与应用程序文件位于同一位置。

参数

  [in] | path_of_data_base | 用于指定文件作为 sqlite 数据库的文件路径。它不应为空字符串，并且应为 UTF-8 编码。

返回
  无。

## ◆ StartUpdateIndex()

FSDK::FullTextSearch::StartUpdateIndex | ( | source | ,
|  | pause | ,
|  | reupdate |
| ) |  |

开始更新文档源对象中定义的 PDF 文件的索引。

此更新可能需要很长时间，因此 Foxit PDF SDK 使用渐进式过程来执行此操作。
只有在文档源中定义的指定目录（包括子目录）下的 PDF 文件 才能被索引。数据库中不位于文档源定义的指定 目录（包括子目录）中的 PDF 文件的索引将被删除。

参数

  [in] | source | 文档源对象，定义要索引的目录。
  [in] | pause | 暂停回调对象，用于决定更新过程是否需要暂停。 这可以是 null，表示在更新过程中不暂停。 如果不是 null，它应该是由用户实现的有效暂停对象。 默认值：null。
  [in] | reupdate | true 表示重新更新数据库中的现有索引信息，而 false 表示不 重新更新数据库中的现有索引信息。默认值：false。

返回
  渐进式对象。请通过函数 FSDK.Progressive.GetRateOfProgress 检查当前进度的比率。如果比率尚未达到 100，请调用函数 FSDK.Progressive.Continue 继续进度，直到进度完成。

## ◆ UpdateIndexWithFilePath()

FSDK::FullTextSearch::UpdateIndexWithFilePath | ( | file_path |  | ) |

更新指定 PDF 文件的索引结果。

此函数可用于更新单个 PDF 文件的索引结果。

参数

  [in] | file_path | 现有的 PDF 文件路径。它不应为空字符串，并且应为 UTF-8 编码。

返回
  true 表示成功，而 false 表示失败。

## 类成员变量说明

## ◆ e_RankNone

FSDK::FullTextSearch::e_RankNone
| static

全文搜索的排序模式枚举。

此枚举的值应单独使用。

不对搜索结果使用排序模式。