←Select platform

Search Method

Summary

Searches the full text database for candidates.

Syntax
C#
VB
C++
Java
public IList<FullTextSearchItem> Search( 
   FullTextSearchItem item 
) 
Public MustOverride Function Search( 
   ByVal item As FullTextSearchItem 
) As System.Collections.Generic.IList(Of Leadtools.Forms.Recognition.FullTextSearchItem) 
public:  
   virtual System::Collections::Generic::IList<Leadtools::Forms::Recognition::FullTextSearchItem^>^ Search( 
      FullTextSearchItem^ item 
   ) abstract 

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

Parameters

item

Properties of the item(s) to search. Must not be null.

Return Value

List of candidates sorted by rank.

Remarks

Used by FormRecognitionEngine or AutoFormsEngine to perform full text search.

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

This method uses the following properties of FullTextSearchItem:

Content
Required: The content to search for must not be null. The engine will use internal free text matching algorithm to return the best candidates.
RepositoryName
Required: Used to generate the unique ID of this item. A value of null or "*" is considered wildcard.
FormName
Required: Used to generate the unique ID of this item. A value of null or "*" is considered wildcard.
PageNumber
Required: Used to generate the unique ID of this item. A value of -1 is considered wildcard.

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.

Requirements
Target Platforms
Help Version 21.0.2021.3.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Forms.Recognition Assembly