FSDK::SearchOption类 参考

Public 成员函数
	constructor ()
	构造函数。
	constructor (is_whole_word, is_case_sensitive, is_search_bookmarks, is_search_in_marup, is_search_in_attachments, is_ignore_accents, is_proximity, is_stemming, is_ignore_full_width, max_docs, word_matching, is_search_doc_text)
	带参数的构造函数。 更多...
	Set (is_whole_word, is_case_sensitive, is_search_bookmarks, is_search_in_marup, is_search_in_attachments, is_ignore_accents, is_proximity, is_stemming, is_ignore_full_width, max_docs, word_matching, is_search_doc_text)
	设置值。 更多...

Public 属性
	is_case_sensitive
	指定搜索查询是否区分大小写。默认值：false。
	is_ignore_accents
	指定在搜索查询项时是否忽略重音和变音符号。默认值：false。
	is_ignore_full_width
	指定文档中的全角和半角字符是否与搜索查询完全匹配。true 表示 忽略全角和半角匹配，而 false 表示完全匹配搜索查询。 默认值：false。
	is_proximity
	指定在执行包含 AND 布尔子句的搜索时，搜索查询是否将反映结果排名中单词的邻近度。 默认值：false。
	is_search_bookmarks
	指定是否搜索书签以查找查询。默认值：false。
	is_search_doc_text
	指定是否搜索文档文本以查找查询。默认值：true。
	is_search_in_attachments
	指定是否应与基础文档一起搜索任何 PDF 文件附件。默认值：false。
	is_search_in_markup
	指定是否搜索标记（注释）以查找查询。默认值：false。
	is_stemming
	指定在执行搜索时，搜索查询是否将考虑单词的词干（例如，run、runs、running）。 默认值：false。
	is_whole_word
	指定搜索是否仅查找查询中指定的完整单词的出现。默认值：false。
	max_docs
	将作为搜索查询的一部分返回的最大文档数。默认值：100。
	word_matching
	查询中的单个单词如何与文档中的单词匹配。此属性仅在查询有多个单词时才相关。 请参考从 FSDK.SearchOption.e_WordMatchingMatchPhrase 开始的值， 此值应为这些值之一。

静态 Public 属性
static	e_WordMatchingMatchAllWords
	单词匹配：匹配所有单词。
static	e_WordMatchingMatchAnyWord
	单词匹配：匹配任何单词。
static	e_WordMatchingMatchPhrase
	用于单词匹配的枚举。 更多...

详细描述

此类表示搜索选项。

成员函数说明

constructor()

FSDK::SearchOption::constructor	(	is_whole_word	,
		is_case_sensitive	,
		is_search_bookmarks	,
		is_search_in_marup	,
		is_search_in_attachments	,
		is_ignore_accents	,
		is_proximity	,
		is_stemming	,
		is_ignore_full_width	,
		max_docs	,
		word_matching	,
		is_search_doc_text
	)

带参数的构造函数。

参数

[in]	is_whole_word	指定搜索是否仅查找查询中指定的完整单词的出现。
[in]	is_case_sensitive	指定搜索查询是否区分大小写。
[in]	is_search_bookmarks	指定是否搜索书签以查找查询。
[in]	is_search_in_markup	指定是否搜索标记（注释）以查找查询。
[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	指定是否搜索文档文本以查找查询。

Set()

FSDK::SearchOption::Set	(	is_whole_word	,
		is_case_sensitive	,
		is_search_bookmarks	,
		is_search_in_marup	,
		is_search_in_attachments	,
		is_ignore_accents	,
		is_proximity	,
		is_stemming	,
		is_ignore_full_width	,
		max_docs	,
		word_matching	,
		is_search_doc_text
	)

设置值。

参数

[in]	is_whole_word	指定搜索是否仅查找查询中指定的完整单词的出现。
[in]	is_case_sensitive	指定搜索查询是否区分大小写。
[in]	is_search_bookmarks	指定是否搜索书签以查找查询。
[in]	is_search_in_markup	指定是否搜索标记（注释）以查找查询。
[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	指定是否搜索文档文本以查找查询。

返回

无。

类成员变量说明

e_WordMatchingMatchPhrase

FSDK::SearchOption::e_WordMatchingMatchPhrase

static

用于单词匹配的枚举。

此枚举的值应单独使用。单词匹配：匹配短语。