Foxit PDF SDK
FoxitPDFSDKPython2.SearchIndexConfig Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def SearchIndexConfig ()
 Constructor. More...
 
def Set (name, is_available, path, is_selected)
 Set values. More...
 

Static Public Attributes

 is_available = _swig_property(_fsdk.SearchIndexConfig_is_available_get, _fsdk.SearchIndexConfig_is_available_set)
 Specifies whether the serch index is available for selection and searching. true means the index is available, while false means not.
 
 is_selected = _swig_property(_fsdk.SearchIndexConfig_is_selected_get, _fsdk.SearchIndexConfig_is_selected_set)
 Specifies whether the search index participates in the search. true means the index is searched as part of the query, while false means it is not searched.
 
 name = _swig_property(_fsdk.SearchIndexConfig_name_get, _fsdk.SearchIndexConfig_name_set)
 The name of search index.
 
 path = _swig_property(_fsdk.SearchIndexConfig_path_get, _fsdk.SearchIndexConfig_path_set)
 The path of the search index.
 

Detailed Description

This class represents search index config.

Constructor & Destructor Documentation

◆ SearchIndexConfig()

def FoxitPDFSDKPython2.SearchIndexConfig.SearchIndexConfig ( )

Constructor.

Constructor, with another search index config object.

Constructor, with parameters.

Parameters
[in]nameThe name of search index.
[in]is_availableSpecifies whether the serch index is available for selection and searching.
[in]pathThe path of the search index.
[in]is_selectedSpecifies whether the search index participates in the search.
[in]search_index_configAnother search index config object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.SearchIndexConfig.Set (   name,
  is_available,
  path,
  is_selected 
)

Set values.

Parameters
[in]nameThe name of search index.
[in]is_availableSpecifies whether the serch index is available for selection and searching.
[in]pathThe path of the search index.
[in]is_selectedSpecifies whether the search index participates in the search.
Returns
None.