←Select platform

GetFullTextSearchCandidatesPage Method (FormRecognitionEngine)

Summary

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

Syntax

C++

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

Public Function GetFullTextSearchCandidatesPage( 
   ByVal formAttributes As FormRecognitionAttributes, 
   ByVal pageNumber As Integer, 
   ByVal masterFormPageNumber As Integer, 
   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^>^ GetFullTextSearchCandidatesPage( 
       FormRecognitionAttributes^ formAttributes, 
      int pageNumber, 
      int masterFormPageNumber, 
      String^ repositoryName, 
      String^ language, 
      FormProgressCallback^ formCallback, 
      PageProgressCallback^ pageCallback 
   )

Parameters

formAttributes

The form attribute object. Must not be null.

pageNumber

1-based page number of the form to compare.

masterFormPageNumber

1-based page number of the master form to compare.

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 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	masterFormPageNumber parameter.
Language	language parameter.
Content	Content of the page of the form obtained upon its initialization.
ScoreRank	Value of FullTextSearchMinimumRank.