Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.SearchOption类 参考

## Public 成员函数
| SearchOption ()
| 构造函数。
| SearchOption (boolean is_whole_word, boolean is_case_sensitive, boolean is_search_bookmarks, boolean is_search_in_marup, boolean is_search_in_attachments, boolean is_ignore_accents, boolean is_proximity, boolean is_stemming, boolean is_ignore_full_width, int max_docs, int word_matching, boolean is_search_doc_text)
| 构造函数，带参数。 更多...
| SearchOption (SearchOption search_option)
| 拷贝构造函数。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
boolean | getIs_case_sensitive ()
| Get 指定搜索查询是否区分大小写。默认值：false。 更多...
boolean | getIs_ignore_accents ()
| Get 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。 更多...
boolean | getIs_ignore_full_width ()
| Get 指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。 更多...
boolean | getIs_proximity ()
| Get 指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。 更多...
boolean | getIs_search_bookmarks ()
| Get 指定是否在书签中搜索查询。默认值：false。 更多...
boolean | getIs_search_doc_text ()
| Get 指定是否在文档文本中搜索查询。默认值：true。 更多...
boolean | getIs_search_in_attachments ()
| Get 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。 更多...
boolean | getIs_search_in_markup ()
| Get 指定是否在标记（注释）中搜索查询。默认值：false。 更多...
boolean | getIs_stemming ()
| Get 指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。 更多...
boolean | getIs_whole_word ()
| Get 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。 更多...
int | getMax_docs ()
| Get 作为搜索查询一部分返回的文档的最大数量。默认值：100。 更多...
int | getWord_matching ()
| Get 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 com.foxit.sdk.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。 更多...
void | set (boolean is_whole_word, boolean is_case_sensitive, boolean is_search_bookmarks, boolean is_search_in_marup, boolean is_search_in_attachments, boolean is_ignore_accents, boolean is_proximity, boolean is_stemming, boolean is_ignore_full_width, int max_docs, int word_matching, boolean is_search_doc_text)
| 设置值。 更多...
void | setIs_case_sensitive (boolean value)
| Set 指定搜索查询是否区分大小写。默认值：false。 更多...
void | setIs_ignore_accents (boolean value)
| Set 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。 更多...
void | setIs_ignore_full_width (boolean value)
| Set 指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。 更多...
void | setIs_proximity (boolean value)
| Set 指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。 更多...
void | setIs_search_bookmarks (boolean value)
| Set 指定是否在书签中搜索查询。默认值：false。 更多...
void | setIs_search_doc_text (boolean value)
| Set 指定是否在文档文本中搜索查询。默认值：true。 更多...
void | setIs_search_in_attachments (boolean value)
| Set 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。 更多...
void | setIs_search_in_markup (boolean value)
| Set 指定是否在标记（注释）中搜索查询。默认值：false。 更多...
void | setIs_stemming (boolean value)
| Set 指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。 更多...
void | setIs_whole_word (boolean value)
| Set 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。 更多...
void | setMax_docs (int value)
| Set 作为搜索查询一部分返回的文档的最大数量。默认值：100。 更多...
void | setWord_matching (int value)
| Set 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 com.foxit.sdk.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。 更多...

## 静态 Public 属性
static final int | e_WordMatchingMatchAllWords = 1
| 单词匹配：匹配所有单词。
static final int | e_WordMatchingMatchAnyWord = 2
| 单词匹配：匹配任意单词。
static final int | e_WordMatchingMatchPhrase = 0
| 单词匹配：匹配短语。

## 详细描述

此类表示搜索选项。

## 构造及析构函数说明

## ◆ SearchOption() [1/2]

com.foxit.sdk.SearchOption.SearchOption | ( | boolean | is_whole_word,
|  | boolean | is_case_sensitive,
|  | boolean | is_search_bookmarks,
|  | boolean | is_search_in_marup,
|  | boolean | is_search_in_attachments,
|  | boolean | is_ignore_accents,
|  | boolean | is_proximity,
|  | boolean | is_stemming,
|  | boolean | is_ignore_full_width,
|  | int | max_docs,
|  | int | word_matching,
|  | boolean | is_search_doc_text
| ) |  |

构造函数，带参数。

参数

  [in] | is_whole_word | 指定搜索是否仅查找查询中指定的完整单词的出现。
  [in] | is_case_sensitive | 指定搜索查询是否区分大小写。
  [in] | is_search_bookmarks | 指定是否在书签中搜索查询。
  [in] | is_search_in_attachments | 指定是否在基础文档的任何PDF文件附件中进行搜索。
  [in] | is_ignore_accents | 指定在搜索查询词时是否忽略重音符号和变音符号。
  [in] | is_proximity | 指定在执行包含AND布尔子句的搜索时，搜索查询是否会在结果排名中反映单词的接近度。
  [in] | is_stemming | 指定在执行搜索时，搜索查询是否会考虑单词的词干变化（例如，run、runs、running）。
  [in] | is_ignore_full_width | 指定文档中的全角和半角字符是否完全匹配搜索查询。
  [in] | max_docs | 作为搜索查询的一部分返回的文档的最大数量。
  [in] | word_matching | 查询中的单个单词如何与文档中的单词匹配。
  [in] | is_search_doc_text | 指定是否在文档文本中搜索查询。

## ◆ SearchOption() [2/2]

com.foxit.sdk.SearchOption.SearchOption | ( | SearchOption | search_option | ) |

拷贝构造函数。

参数

  [in] | search_option | 另一个搜索选项对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.SearchOption.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getIs_case_sensitive()

com.foxit.sdk.SearchOption.getIs_case_sensitive | ( |  | ) |

Get 指定搜索查询是否区分大小写。默认值：false。

返回
  指定搜索查询是否区分大小写。默认值：false。

## ◆ getIs_ignore_accents()

com.foxit.sdk.SearchOption.getIs_ignore_accents | ( |  | ) |

Get 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。

返回
  指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。

## ◆ getIs_ignore_full_width()

com.foxit.sdk.SearchOption.getIs_ignore_full_width | ( |  | ) |

Get 指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。

返回
  指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。

## ◆ getIs_proximity()

com.foxit.sdk.SearchOption.getIs_proximity | ( |  | ) |

Get 指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。

返回
  指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。

## ◆ getIs_search_bookmarks()

com.foxit.sdk.SearchOption.getIs_search_bookmarks | ( |  | ) |

Get 指定是否在书签中搜索查询。默认值：false。

返回
  指定是否在书签中搜索查询。默认值：false。

## ◆ getIs_search_doc_text()

com.foxit.sdk.SearchOption.getIs_search_doc_text | ( |  | ) |

Get 指定是否在文档文本中搜索查询。默认值：true。

返回
  指定是否在文档文本中搜索查询。默认值：true。

## ◆ getIs_search_in_attachments()

com.foxit.sdk.SearchOption.getIs_search_in_attachments | ( |  | ) |

Get 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。

返回
  指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。

## ◆ getIs_search_in_markup()

com.foxit.sdk.SearchOption.getIs_search_in_markup | ( |  | ) |

Get 指定是否在标记（注释）中搜索查询。默认值：false。

返回
  指定是否在标记（注释）中搜索查询。默认值：false。

## ◆ getIs_stemming()

com.foxit.sdk.SearchOption.getIs_stemming | ( |  | ) |

Get 指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。

返回
  指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。

## ◆ getIs_whole_word()

com.foxit.sdk.SearchOption.getIs_whole_word | ( |  | ) |

Get 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。

返回
  指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。

## ◆ getMax_docs()

com.foxit.sdk.SearchOption.getMax_docs | ( |  | ) |

Get 作为搜索查询一部分返回的文档的最大数量。默认值：100。

返回
  作为搜索查询一部分返回的文档的最大数量。默认值：100。

## ◆ getWord_matching()

com.foxit.sdk.SearchOption.getWord_matching | ( |  | ) |

Get 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 com.foxit.sdk.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。

返回
  查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 com.foxit.sdk.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。

## ◆ set()

void com.foxit.sdk.SearchOption.set | ( | boolean | is_whole_word,
|  | boolean | is_case_sensitive,
|  | boolean | is_search_bookmarks,
|  | boolean | is_search_in_marup,
|  | boolean | is_search_in_attachments,
|  | boolean | is_ignore_accents,
|  | boolean | is_proximity,
|  | boolean | is_stemming,
|  | boolean | is_ignore_full_width,
|  | int | max_docs,
|  | int | word_matching,
|  | boolean | is_search_doc_text
| ) |  |

设置值。

参数

  [in] | is_whole_word | 指定搜索是否仅查找查询中指定的完整单词的出现。
  [in] | is_case_sensitive | 指定搜索查询是否区分大小写。
  [in] | is_search_bookmarks | 指定是否在书签中搜索查询。
  [in] | is_search_in_attachments | 指定是否在基础文档的任何PDF文件附件中进行搜索。
  [in] | is_ignore_accents | 指定在搜索查询词时是否忽略重音符号和变音符号。
  [in] | is_proximity | 指定在执行包含AND布尔子句的搜索时，搜索查询是否会在结果排名中反映单词的接近度。
  [in] | is_stemming | 指定在执行搜索时，搜索查询是否会考虑单词的词干变化（例如，run、runs、running）。
  [in] | is_ignore_full_width | 指定文档中的全角和半角字符是否精确匹配搜索查询。
  [in] | max_docs | 作为搜索查询结果返回的文档的最大数量。
  [in] | word_matching | 查询中的单个单词将如何与文档中的单词匹配。
  [in] | is_search_doc_text | 指定是否在文档文本中搜索查询。

返回
  无。

## ◆ setIs_case_sensitive()

com.foxit.sdk.SearchOption.setIs_case_sensitive | ( | boolean | value | ) |

Set 指定搜索查询是否区分大小写。默认值：false。

参数

  [in] | value | 指定搜索查询是否区分大小写。默认值：false。

返回
  None.

## ◆ setIs_ignore_accents()

com.foxit.sdk.SearchOption.setIs_ignore_accents | ( | boolean | value | ) |

Set 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。

参数

  [in] | value | 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。

返回
  None.

## ◆ setIs_ignore_full_width()

com.foxit.sdk.SearchOption.setIs_ignore_full_width | ( | boolean | value | ) |

Set 指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。

参数

  [in] | value | 指定文档中的全角和半角字符是否精确匹配搜索查询。true 表示 忽略全角和半角匹配，false 表示精确匹配搜索查询。 默认值：false。

返回
  None.

## ◆ setIs_proximity()

com.foxit.sdk.SearchOption.setIs_proximity | ( | boolean | value | ) |

Set 指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。

参数

  [in] | value | 指定包含AND布尔子句的搜索时，搜索查询是否在结果排序中反映单词的接近性。默认值：false。

返回
  None.

## ◆ setIs_search_bookmarks()

com.foxit.sdk.SearchOption.setIs_search_bookmarks | ( | boolean | value | ) |

Set 指定是否在书签中搜索查询。默认值：false。

参数

  [in] | value | 指定是否在书签中搜索查询。默认值：false。

返回
  None.

## ◆ setIs_search_doc_text()

com.foxit.sdk.SearchOption.setIs_search_doc_text | ( | boolean | value | ) |

Set 指定是否在文档文本中搜索查询。默认值：true。

参数

  [in] | value | 指定是否在文档文本中搜索查询。默认值：true。

返回
  None.

## ◆ setIs_search_in_attachments()

com.foxit.sdk.SearchOption.setIs_search_in_attachments | ( | boolean | value | ) |

Set 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。

参数

  [in] | value | 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。

返回
  None.

## ◆ setIs_search_in_markup()

com.foxit.sdk.SearchOption.setIs_search_in_markup | ( | boolean | value | ) |

Set 指定是否在标记（注释）中搜索查询。默认值：false。

参数

  [in] | value | 指定是否在标记（注释）中搜索查询。默认值：false。

返回
  None.

## ◆ setIs_stemming()

com.foxit.sdk.SearchOption.setIs_stemming | ( | boolean | value | ) |

Set 指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。

参数

  [in] | value | 指定执行搜索时搜索查询是否考虑单词的词干变化（例如，run、runs、running）。默认值：false。

返回
  None.

## ◆ setIs_whole_word()

com.foxit.sdk.SearchOption.setIs_whole_word | ( | boolean | value | ) |

Set 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。

参数

  [in] | value | 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。

返回
  None.

## ◆ setMax_docs()

com.foxit.sdk.SearchOption.setMax_docs | ( | int | value | ) |

Set 作为搜索查询一部分返回的文档的最大数量。默认值：100。

参数

  [in] | value | 作为搜索查询一部分返回的文档的最大数量。默认值：100。

返回
  None.

## ◆ setWord_matching()

com.foxit.sdk.SearchOption.setWord_matching | ( | int | value | ) |

Set 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 com.foxit.sdk.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。

参数

  [in] | value | 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询 包含多个单词时相关。请参考从 com.foxit.sdk.SearchOption.e_WordMatchingMatchPhrase 开始的值， 应该是这些值中的一个。

返回
  None.