UpsertMasterFormToFullTextSearch Method

Summary

Adds or updates a master form to the full text search database.

Syntax

C++

Java

public void UpsertMasterFormToFullTextSearch( 
   FormRecognitionAttributes masterAttributes, 
   string repositoryName, 
   string language, 
   string userData, 
   FormProgressCallback formCallback, 
   PageProgressCallback pageCallback 
)

Public Sub UpsertMasterFormToFullTextSearch( 
   ByVal masterAttributes As FormRecognitionAttributes, 
   ByVal repositoryName As String, 
   ByVal language As String, 
   ByVal userData As String, 
   ByVal formCallback As FormProgressCallback, 
   ByVal pageCallback As PageProgressCallback 
)

public:  
   void UpsertMasterFormToFullTextSearch( 
       FormRecognitionAttributes^ masterAttributes, 
      String^ repositoryName, 
      String^ language, 
      String^ userData, 
      FormProgressCallback^ formCallback, 
      PageProgressCallback^ pageCallback 
   )

public void upsertMasterFormToFullTextSearch( 
   FormRecognitionAttributes masterAttributes, 
   java.lang.String repositoryName, 
   java.lang.String language, 
   java.lang.String userData, 
   FormProgressCallback formCallback, 
   PageProgressCallback pageCallback 
);

Parameters

masterAttributes

Attributes of the master form. 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).

userData

Optional user data value. This will be saved to the store and can be retrieved later when getting the candidates. Can be null.

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.

Remarks

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

Member	Value
RepositoryName	repositoryName parameter.
FormName	Name of the form obtained from masterAttributes.
PageNumber	Will be set from 1 to the number of pages in the forms and repeated.
Language	language parameter.
Content	Content of the page saved during its creation.
UserData	userData parameter.

Call UpsertMasterFormToFullTextSearch after the master form has been created and added to the repository or when the content of the master form has changed.

Call the Index method of FullTextSearchManager after this method returns.

For more information, refer to Speeding Up Forms Recognition Using the Full Text Search Feature.

Requirements

Target Platforms

Reference

FormRecognitionEngine Class

FormRecognitionEngine Members

Leadtools.Forms.Recognition Namespace

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Forms.Recognition Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Recognition Namespace

Assemblies