Search Method

Searches the full text database for candidates.

public IList<FullTextSearchItem> Search( 
   FullTextSearchItem item 
) 

public:  
   virtual System::Collections::Generic::IList<Leadtools::Forms::Recognition::FullTextSearchItem^>^ Search( 
      FullTextSearchItem^ item 
   ) abstract 

public abstract java.util.List<FullTextSearchItem> search( 
   FullTextSearchItem item 
); 

def Search(self,item): 

Parameters

Return Value

List of candidates sorted by rank.

Used by FormRecognitionEngine or AutoFormsEngine to perform full text search.

This method searches the content of the master form pages previously added to the full text search database with properties matching item.

This method uses the following properties of FullTextSearchItem:

The wildcard rules can be used to search all master forms pages, all master forms of a repository or all forms in all repositories. For example to search all items, use:

FullTextSearchItem.RepositoryName = "*" or null, FullTextSearchItem.FormName = "*" or null, FullTextSearchItem.PageNumber = -1

To search all forms in a repository, use:

FullTextSearchItem.RepositoryName = "RepoName", FullTextSearchItem.FormName = "*" or null, FullTextSearchItem.PageNumber = -1

To search a specific form, use:

FullTextSearchItem.RepositoryName = "RepoName", FullTextSearchItem.FormName = "FormName", FullTextSearchItem.PageNumber = -1

To search a specific page, use:

FullTextSearchItem.RepositoryName = "RepoName", FullTextSearchItem.FormName = "FormName", FullTextSearchItem.PageNumber = pageNumber

The value of ScoreRank of each item returned will contain a value between 0 (worst) and 100 (best) depending on an internal free text matching algorithm between the content passed to this method and the content of the item stored in the database. This method will retrieve the results sorted from highest rank to lowest. The value of UserData of the result items will be populated by the same value used during Upsert(FullTextSearchItem) of the result items is not be populated by this method.

Target Platforms

Reference

IFullTextSearchManager Class

IFullTextSearchManager Members

Leadtools.Forms.Recognition Namespace