←Select platform

Select Method

Summary

Returns matching forms with content.

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

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

Parameters

item

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

Return Value

The items found.

Remarks

Used by FormRecognitionEngine or AutoFormsEngine to perform full text search.

This method finds one or more master form pages from the full text search database with properties matching item.

This method uses the following properties of FullTextSearchItem:

Property Description
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 find all master forms pages, all master forms of a repository or all forms in all repositories. For example to find all items, use:

FullTextSearchItem.RepositoryName = "*" or null, FullTextSearchItem.FormName = "*" or null, FullTextSearchItem.PageNumber = -1

To find all forms in a repository, use:

FullTextSearchItem.RepositoryName = "RepoName", FullTextSearchItem.FormName = "*" or null, FullTextSearchItem.PageNumber = -1

To find a specific form, use:

FullTextSearchItem.RepositoryName = "RepoName", FullTextSearchItem.FormName = "FormName", FullTextSearchItem.PageNumber = -1

To find a specific page, use:

FullTextSearchItem.RepositoryName = "RepoName", FullTextSearchItem.FormName = "FormName", FullTextSearchItem.PageNumber = pageNumber

The values of Content and 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