←Select platform

Upsert(FullTextSearchItem) Method

Summary

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

Syntax
C#
C++/CLI
Java
Python
public void Upsert( 
   FullTextSearchItem item 
) 
public:  
   virtual void Upsert( 
      FullTextSearchItem^ item 
   ) abstract 
public abstract void upsert( 
   FullTextSearchItem item 
); 
def Upsert(self,item): 

Parameters

item

Properties of the item to add or update. Must not be null.

Remarks

Used by FormRecognitionEngine or AutoFormsEngine to perform full text search.

This method adds or updates a new master form page to the full text search database. If an item with these properties already exists, then its metadata will get updated.

The engine will use the values of RepositoryName, FormName and PageNumber to create the unique identifier of this form in the database.

This method uses the following properties of FullTextSearchItem:

Property

Description

RepositoryName

Required: Used to generate the unique ID of this item. Must not be null.

FormName

Required: Used to generate the unique ID of this item. Must not be null or an empty string.

PageNumber

Required: Used to generate the unique ID of this item. If this value is 0, then 1 is automatically used.

Content

Required: The content to index. Must not be null. Replaces old data if the item already exist.

Language

Optional: The language of Content. If this value is null, then English is assumed.

UserData

Optional: Any user-defined data to associate with this item. Replaces old data if the item already exist.

Index must be called after Upsert(FullTextSearchItem).

Use IFullTextSearchManager.Upsert(IEnumerable<FullTextSearchItem>) to add or update multiple items with one call to increase performance.

Requirements

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Forms.Recognition Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.