Foxit PDF SDK
fsdk.FindOption Class Reference

Public Member Functions

def GetIs_case_sensitive ()
 Get a boolean value specifies that whether to match case. More...
 
def GetIs_whole_word ()
 Get a boolean value specifies that whether to match whole words only. More...
 
def Set (is_whole_word, is_case_sensitive)
 Set value.
More...
 
def SetIs_case_sensitive (value)
 Set a boolean value specifies that whether to match case. More...
 
def SetIs_whole_word (value)
 Set a boolean value specifies that whether to match whole words only. More...
 

Detailed Description

This class represents the find option which is used by TextSearchReplace objects.

Member Function Documentation

◆ GetIs_case_sensitive()

fsdk.FindOption.GetIs_case_sensitive ( )

Get a boolean value specifies that whether to match case.

Returns
A boolean value specifies that whether to match case.true means to match case, otherwise no.

◆ GetIs_whole_word()

fsdk.FindOption.GetIs_whole_word ( )

Get a boolean value specifies that whether to match whole words only.

Returns
A boolean value specifies that whether to match whole words only. true means to match whole words only, otherwise no.

◆ Set()

def fsdk.FindOption.Set (   is_whole_word,
  is_case_sensitive 
)

Set value.

Parameters
[in]is_whole_wordA boolean value specifies that whether to match whole words only. true means to match whole words only, otherwise no.
[in]is_case_sensitiveA boolean value specifies that whether to match case.true means to match case, otherwise no.
Returns
None.

◆ SetIs_case_sensitive()

fsdk.FindOption.SetIs_case_sensitive (   value)

Set a boolean value specifies that whether to match case.

Parameters
[in]valueA boolean value specifies that whether to match case.true means to match case, otherwise no.
Returns
None.

◆ SetIs_whole_word()

fsdk.FindOption.SetIs_whole_word (   value)

Set a boolean value specifies that whether to match whole words only.

Parameters
[in]valueA boolean value specifies that whether to match whole words only. true means to match whole words only, otherwise no.
Returns
None.