Foxit PDF SDK
fsdk.SearchOption Class Reference

Public Member Functions

def GetIs_case_sensitive ()
 Get specifies whether the search query is case sensitive. More...
 
def GetIs_ignore_accents ()
 Get specifies whether accents and diacriticals are ignored while searching the query term. More...
 
def GetIs_ignore_full_width ()
 Get specifies whether full width and half width characters in the document exactly match the search query. More...
 
def GetIs_proximity ()
 Get specifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses. More...
 
def GetIs_search_bookmarks ()
 Get specifies whether bookmarks are searched for the query. More...
 
def GetIs_search_doc_text ()
 Get specifies whether the document text is searched for the query. More...
 
def GetIs_search_in_attachments ()
 Get specifies whether any PDF file attachments should be searched along with the base document. More...
 
def GetIs_search_in_markup ()
 Get specifies whether markup (annotations) are searched for the query. More...
 
def GetIs_stemming ()
 Get specifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search. More...
 
def GetIs_whole_word ()
 Get specifies whether search finds only occurrences of complete words that are specified in the query. More...
 
def GetMax_docs ()
 Get the maximum number of documents that will be returned as part of the search query. More...
 
def GetWord_matching ()
 Get how individual words in the query will be matched to words in the document. More...
 
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)
 Set values.
More...
 
def SetIs_case_sensitive (value)
 Set specifies whether the search query is case sensitive. More...
 
def SetIs_ignore_accents (value)
 Set specifies whether accents and diacriticals are ignored while searching the query term. More...
 
def SetIs_ignore_full_width (value)
 Set specifies whether full width and half width characters in the document exactly match the search query. More...
 
def SetIs_proximity (value)
 Set specifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses. More...
 
def SetIs_search_bookmarks (value)
 Set specifies whether bookmarks are searched for the query. More...
 
def SetIs_search_doc_text (value)
 Set specifies whether the document text is searched for the query. More...
 
def SetIs_search_in_attachments (value)
 Set specifies whether any PDF file attachments should be searched along with the base document. More...
 
def SetIs_search_in_markup (value)
 Set specifies whether markup (annotations) are searched for the query. More...
 
def SetIs_stemming (value)
 Set specifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search. More...
 
def SetIs_whole_word (value)
 Set specifies whether search finds only occurrences of complete words that are specified in the query. More...
 
def SetMax_docs (value)
 Set the maximum number of documents that will be returned as part of the search query. More...
 
def SetWord_matching (value)
 Set how individual words in the query will be matched to words in the document. More...
 

Detailed Description

This class represents search option.

Member Function Documentation

◆ GetIs_case_sensitive()

fsdk.SearchOption.GetIs_case_sensitive ( )

Get specifies whether the search query is case sensitive.

Returns
Specifies whether the search query is case sensitive. Defaule value: false.

◆ GetIs_ignore_accents()

fsdk.SearchOption.GetIs_ignore_accents ( )

Get specifies whether accents and diacriticals are ignored while searching the query term.

Returns
Specifies whether accents and diacriticals are ignored while searching the query term. Defaule value: false.

◆ GetIs_ignore_full_width()

fsdk.SearchOption.GetIs_ignore_full_width ( )

Get specifies whether full width and half width characters in the document exactly match the search query.

Returns
Specifies whether full width and half width characters in the document exactly match the search query. true means ignore full width and half width matching, while false means exactly match the search query. Defaule value: false.

◆ GetIs_proximity()

fsdk.SearchOption.GetIs_proximity ( )

Get specifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses.

Returns
Specifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses. Defaule value: false.

◆ GetIs_search_bookmarks()

fsdk.SearchOption.GetIs_search_bookmarks ( )

Get specifies whether bookmarks are searched for the query.

Returns
Specifies whether bookmarks are searched for the query. Defaule value: false.

◆ GetIs_search_doc_text()

fsdk.SearchOption.GetIs_search_doc_text ( )

Get specifies whether the document text is searched for the query.

Returns
Specifies whether the document text is searched for the query. Defaule value: true.

◆ GetIs_search_in_attachments()

fsdk.SearchOption.GetIs_search_in_attachments ( )

Get specifies whether any PDF file attachments should be searched along with the base document.

Returns
Specifies whether any PDF file attachments should be searched along with the base document. Defaule value: false.

◆ GetIs_search_in_markup()

fsdk.SearchOption.GetIs_search_in_markup ( )

Get specifies whether markup (annotations) are searched for the query.

Returns
Specifies whether markup (annotations) are searched for the query. Defaule value: false.

◆ GetIs_stemming()

fsdk.SearchOption.GetIs_stemming ( )

Get specifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search.

Returns
Specifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search. Defaule value: false.

◆ GetIs_whole_word()

fsdk.SearchOption.GetIs_whole_word ( )

Get specifies whether search finds only occurrences of complete words that are specified in the query.

Returns
Specifies whether search finds only occurrences of complete words that are specified in the query. Defaule value: false.

◆ GetMax_docs()

fsdk.SearchOption.GetMax_docs ( )

Get the maximum number of documents that will be returned as part of the search query.

Returns
The maximum number of documents that will be returned as part of the search query. Defaule value: 100.

◆ GetWord_matching()

fsdk.SearchOption.GetWord_matching ( )

Get how individual words in the query will be matched to words in the document.

Returns
How individual words in the query will be matched to words in the document. This property is relevant only when a query has more than one word. Please refer to values starting from fsdk.SearchOptionE_WordMatchingMatchPhrase and this should be one of these values.

◆ 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 
)

Set values.

Parameters
[in]is_whole_wordSpecifies whether search finds only occurrences of complete words that are specified in the query.
[in]is_case_sensitiveSpecifies whether the search query is case sensitive.
[in]is_search_bookmarksSpecifies whether bookmarks are searched for the query.
[in]is_search_in_attachmentsSpecifies whether any PDF file attachments should be searched along with the base document.
[in]is_ignore_accentsSpecifies whether accents and diacriticals are ignored while searching the query term.
[in]is_proximitySpecifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses.
[in]is_stemmingSpecifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search.
[in]is_ignore_full_widthSpecifies whether full width and half width characters in the document exactly match the search query.
[in]max_docsThe maximum number of documents that will be returned as part of the search query.
[in]word_matchingHow individual words in the query will be matched to words in the document.
[in]is_search_doc_textSpecifies whether the document text is searched for the query.
Returns
None.

◆ SetIs_case_sensitive()

fsdk.SearchOption.SetIs_case_sensitive (   value)

Set specifies whether the search query is case sensitive.

Parameters
[in]valueSpecifies whether the search query is case sensitive. Defaule value: false.
Returns
None.

◆ SetIs_ignore_accents()

fsdk.SearchOption.SetIs_ignore_accents (   value)

Set specifies whether accents and diacriticals are ignored while searching the query term.

Parameters
[in]valueSpecifies whether accents and diacriticals are ignored while searching the query term. Defaule value: false.
Returns
None.

◆ SetIs_ignore_full_width()

fsdk.SearchOption.SetIs_ignore_full_width (   value)

Set specifies whether full width and half width characters in the document exactly match the search query.

Parameters
[in]valueSpecifies whether full width and half width characters in the document exactly match the search query. true means ignore full width and half width matching, while false means exactly match the search query. Defaule value: false.
Returns
None.

◆ SetIs_proximity()

fsdk.SearchOption.SetIs_proximity (   value)

Set specifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses.

Parameters
[in]valueSpecifies whether the search query will reflect the proximity of words in the results ranking when performing the search that contains AND Boolean clauses. Defaule value: false.
Returns
None.

◆ SetIs_search_bookmarks()

fsdk.SearchOption.SetIs_search_bookmarks (   value)

Set specifies whether bookmarks are searched for the query.

Parameters
[in]valueSpecifies whether bookmarks are searched for the query. Defaule value: false.
Returns
None.

◆ SetIs_search_doc_text()

fsdk.SearchOption.SetIs_search_doc_text (   value)

Set specifies whether the document text is searched for the query.

Parameters
[in]valueSpecifies whether the document text is searched for the query. Defaule value: true.
Returns
None.

◆ SetIs_search_in_attachments()

fsdk.SearchOption.SetIs_search_in_attachments (   value)

Set specifies whether any PDF file attachments should be searched along with the base document.

Parameters
[in]valueSpecifies whether any PDF file attachments should be searched along with the base document. Defaule value: false.
Returns
None.

◆ SetIs_search_in_markup()

fsdk.SearchOption.SetIs_search_in_markup (   value)

Set specifies whether markup (annotations) are searched for the query.

Parameters
[in]valueSpecifies whether markup (annotations) are searched for the query. Defaule value: false.
Returns
None.

◆ SetIs_stemming()

fsdk.SearchOption.SetIs_stemming (   value)

Set specifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search.

Parameters
[in]valueSpecifies whether the search query will take the stemming of words (for example, run, runs, running) into account when performing the search. Defaule value: false.
Returns
None.

◆ SetIs_whole_word()

fsdk.SearchOption.SetIs_whole_word (   value)

Set specifies whether search finds only occurrences of complete words that are specified in the query.

Parameters
[in]valueSpecifies whether search finds only occurrences of complete words that are specified in the query. Defaule value: false.
Returns
None.

◆ SetMax_docs()

fsdk.SearchOption.SetMax_docs (   value)

Set the maximum number of documents that will be returned as part of the search query.

Parameters
[in]valueThe maximum number of documents that will be returned as part of the search query. Defaule value: 100.
Returns
None.

◆ SetWord_matching()

fsdk.SearchOption.SetWord_matching (   value)

Set how individual words in the query will be matched to words in the document.

Parameters
[in]valueHow individual words in the query will be matched to words in the document. This property is relevant only when a query has more than one word. Please refer to values starting from fsdk.SearchOptionE_WordMatchingMatchPhrase and this should be one of these values.
Returns
None.