Public 成员函数
def	GetIs_case_sensitive ()
	Get 指定搜索查询是否区分大小写。默认值：false。更多...

def	GetIs_ignore_accents ()
	Get 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。更多...

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

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

def	GetIs_search_bookmarks ()
	Get 指定是否在书签中搜索查询。默认值：false。更多...

def	GetIs_search_doc_text ()
	Get 指定是否在文档文本中搜索查询。默认值：true。更多...

def	GetIs_search_in_attachments ()
	Get 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。更多...

def	GetIs_search_in_markup ()
	Get 指定是否在标记（注释）中搜索查询。默认值：false。更多...

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

def	GetIs_whole_word ()
	Get 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。更多...

def	GetMax_docs ()
	Get 作为搜索查询一部分返回的文档的最大数量。默认值：100。更多...

def	GetWord_matching ()
	Get 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询包含多个单词时相关。请参考从 fsdk.SearchOptionE_WordMatchingMatchPhrase 开始的值，应该是这些值中的一个。更多...

def	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)
	设置值。更多...

def	SetIs_case_sensitive (value)
	Set 指定搜索查询是否区分大小写。默认值：false。更多...

def	SetIs_ignore_accents (value)
	Set 指定在搜索查询术语时是否忽略重音符号和变音符。默认值：false。更多...

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

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

def	SetIs_search_bookmarks (value)
	Set 指定是否在书签中搜索查询。默认值：false。更多...

def	SetIs_search_doc_text (value)
	Set 指定是否在文档文本中搜索查询。默认值：true。更多...

def	SetIs_search_in_attachments (value)
	Set 指定是否应与基础文档一起搜索任何PDF文件附件。默认值：false。更多...

def	SetIs_search_in_markup (value)
	Set 指定是否在标记（注释）中搜索查询。默认值：false。更多...

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

def	SetIs_whole_word (value)
	Set 指定搜索是否只查找查询中指定的完整单词的出现。默认值：false。更多...

def	SetMax_docs (value)
	Set 作为搜索查询一部分返回的文档的最大数量。默认值：100。更多...

def	SetWord_matching (value)
	Set 查询中的单个单词如何与文档中的单词匹配。此属性仅在查询包含多个单词时相关。请参考从 fsdk.SearchOptionE_WordMatchingMatchPhrase 开始的值，应该是这些值中的一个。更多...

详细描述

此类表示搜索选项。

成员函数说明

◆ GetIs_case_sensitive()

fsdk.SearchOption.GetIs_case_sensitive ( )

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

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

◆ GetIs_ignore_accents()

fsdk.SearchOption.GetIs_ignore_accents ( )

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

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

◆ GetIs_ignore_full_width()

fsdk.SearchOption.GetIs_ignore_full_width ( )

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

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

◆ GetIs_proximity()

fsdk.SearchOption.GetIs_proximity ( )

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

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

◆ GetIs_search_bookmarks()

fsdk.SearchOption.GetIs_search_bookmarks ( )

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

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

◆ GetIs_search_doc_text()

fsdk.SearchOption.GetIs_search_doc_text ( )

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

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

◆ GetIs_search_in_attachments()

fsdk.SearchOption.GetIs_search_in_attachments ( )

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

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

◆ GetIs_search_in_markup()

fsdk.SearchOption.GetIs_search_in_markup ( )

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

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

◆ GetIs_stemming()

fsdk.SearchOption.GetIs_stemming ( )

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

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

◆ GetIs_whole_word()

fsdk.SearchOption.GetIs_whole_word ( )

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

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

◆ GetMax_docs()

fsdk.SearchOption.GetMax_docs ( )

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

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

◆ GetWord_matching()

fsdk.SearchOption.GetWord_matching ( )

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

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

◆ Set()

def 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_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()

fsdk.SearchOption.SetIs_case_sensitive ( value )

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

参数

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

返回: None.

◆ SetIs_ignore_accents()

fsdk.SearchOption.SetIs_ignore_accents ( value )

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

参数

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

返回: None.

◆ SetIs_ignore_full_width()

fsdk.SearchOption.SetIs_ignore_full_width ( value )

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

参数

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

返回: None.

◆ SetIs_proximity()

fsdk.SearchOption.SetIs_proximity ( value )

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

参数

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

返回: None.

◆ SetIs_search_bookmarks()

fsdk.SearchOption.SetIs_search_bookmarks ( value )

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

参数

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

返回: None.

◆ SetIs_search_doc_text()

fsdk.SearchOption.SetIs_search_doc_text ( value )

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

参数

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

返回: None.

◆ SetIs_search_in_attachments()

fsdk.SearchOption.SetIs_search_in_attachments ( value )

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

参数

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

返回: None.

◆ SetIs_search_in_markup()

fsdk.SearchOption.SetIs_search_in_markup ( value )

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

参数

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

返回: None.

◆ SetIs_stemming()

fsdk.SearchOption.SetIs_stemming ( value )

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

参数

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

返回: None.

◆ SetIs_whole_word()

fsdk.SearchOption.SetIs_whole_word ( value )

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

参数

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

返回: None.

◆ SetMax_docs()

fsdk.SearchOption.SetMax_docs ( value )

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

参数

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

返回: None.

◆ SetWord_matching()

fsdk.SearchOption.SetWord_matching ( value )

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

参数

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

返回: None.

Public 成员函数

详细描述

成员函数说明

◆ GetIs_case_sensitive()

◆ GetIs_ignore_accents()

◆ GetIs_ignore_full_width()

◆ GetIs_proximity()

◆ GetIs_search_bookmarks()

◆ GetIs_search_doc_text()

◆ GetIs_search_in_attachments()

◆ GetIs_search_in_markup()

◆ GetIs_stemming()

◆ GetIs_whole_word()

◆ GetMax_docs()

◆ GetWord_matching()

◆ Set()

◆ SetIs_case_sensitive()

◆ SetIs_ignore_accents()

◆ SetIs_ignore_full_width()

◆ SetIs_proximity()

◆ SetIs_search_bookmarks()

◆ SetIs_search_doc_text()

◆ SetIs_search_in_attachments()

◆ SetIs_search_in_markup()

◆ SetIs_stemming()

◆ SetIs_whole_word()

◆ SetMax_docs()

◆ SetWord_matching()