←Select platform

GetFullTextSearchCandidatesForm Method (FormRecognitionEngine)

Summary

Finds all the master form candidates for a form using full text search.

Syntax

C++

public System.Collections.Generic.IList<Leadtools.Forms.Recognition.FullTextSearchItem> GetFullTextSearchCandidatesForm( 
   FormRecognitionAttributes formAttributes, 
   string repositoryName, 
   string language, 
   FormProgressCallback formCallback, 
   PageProgressCallback pageCallback 
)

Public Function GetFullTextSearchCandidatesForm( 
   ByVal formAttributes As FormRecognitionAttributes, 
   ByVal repositoryName As String, 
   ByVal language As String, 
   ByVal formCallback As FormProgressCallback, 
   ByVal pageCallback As PageProgressCallback 
) As System.Collections.Generic.IList(Of Leadtools.Forms.Recognition.FullTextSearchItem)

public:  
   System::Collections::Generic::IList<Leadtools::Forms::Recognition::FullTextSearchItem^>^ GetFullTextSearchCandidatesForm( 
       FormRecognitionAttributes^ formAttributes, 
      String^ repositoryName, 
      String^ language, 
      FormProgressCallback^ formCallback, 
      PageProgressCallback^ pageCallback 
   )

Parameters

formAttributes

The form attribute object. Must not be null.

repositoryName

Repository name. If this value is null or an empty string, then an empty string is used to indicate a default repository without a name.

language

Optional language of the form. Passing null will default to "en-US" (or locale ID 1033).

formCallback

Status about the progress of the operation at the form level (i.e. page by page). Can be null.

pageCallback

Provides status on the progress of the operation at the page level. Can be null.

Return Value

List of candidates sorted by rank.

Remarks

This method will compare the first page of the form with the first page of all master forms added to the full text search engine. To compare a specific page, use GetFullTextSearchCandidatesPage.

This method creates a new instance of FullTextSearchItem, fills it up using the values described below and then calls IFullTextSearchManager.Search to perform its operation:

Member	Value
RepositoryName	repositoryName parameter.
PageNumber	1
Language	language parameter.
Content	Content of the page of the form obtained upon its initialization.
ScoreRank	Value of FullTextSearchMinimumRank.