←Select platform
In This Topic ▼

FormRecognitionEngine Class Members

Summary

The following tables list the members exposed by FormRecognitionEngine.

Public Constructors

Name Description
Public Constructor
 FormRecognitionEngine Initializes a new FormRecognitionEngine class object.

Public Methods

Name Description
Public Method
 AddFormPage Appends a new page to the specified Form attributes object. The Form attributes object should be opened before the addition using OpenForm.
Public Method AddMasterFormPage Appends a new page to the specified Master Form attributes object. The Master Form attributes object should be opened before the addition using OpenMasterForm.
Public Method CloseForm Closes an open FormRecognitionAttributes object associated with a Form.
Public Method CloseMasterForm Closes an open FormRecognitionAttributes object associated with a Master Form.
Public Method CompareExtendedForm Returns a FormRecognitionResult object determines how close is the specified Form to the specified Master Form.
Public Method CompareForm Returns a FormRecognitionResult object determines how close is the specified Form to the specified Master Form.
Public Method CompareFormFast Returns a FormRecognitionResult object determines how close is the specified Form to the specified Master Form.
Public Method ComparePage Returns a PageRecognitionResult object that describes how close the specified Form page is in comparison to the specified Master Form page.
Public Method CreateForm Creates a new form, with the specified options, for use in recognition It returns a FormRecognitionEngine object that you can use for creating any Form.
Public Method CreateMasterForm Creates a new Master Form attribute object with the specified options.
Public Method DeleteFormPage Deletes the specified page from the specified Form attribute object.
Public Method DeleteMasterFormFromFullTextSearch Deletes master form (by name) from the full text search database.
Public Method DeleteMasterFormPage Deletes the specified page from the specified Master Form.
Public Method FillFieldsInformation Update passed Leadtools.Forms.Processing.FormPages by filling Extra-information after recognition phase but before Processing phase.
Public Method GetFormAlignment Returns a list of Leadtools.Forms.Common.PageAlignment objects that determines the amount of shift and scaling for each page of the Form with its corresponding page in the specified Master Form.
Public Method GetFormProperties Returns a FormRecognitionProperties object that provides information about the specified FormRecognitionAttributes such as isMaster, name, ID, creation time, modification time, last access time, and the number of pages.
Public Method GetFullTextSearchCandidatesForm Finds all the master form candidates for a form using full text search.
Public Method GetFullTextSearchCandidatesPage Finds all the master form candidates for a form page using full text search.
Public Method GetPageAlignment Returns a Leadtools.Forms.Common.PageAlignment object which specifies the amount of shift and scaling for a specific form page, according to the specified Master Form.
Public Method GetPageOptions Returns a PageRecognitionOptions object from specific page number in FormRecognitionAttributes.
Public Method InsertFormPage Appends a new page to the specified Form attributes object. The Form attributes object should be opened before the addition using OpenForm.
Public Method InsertMasterFormPage Appends a new page to the specified Master Form attributes object. The Master Form attributes object should be opened before the addition using OpenMasterForm.
Public Method IsMasterFormInFullTextSearch Detects if the master form has been added to the full text database.
Public Method OpenForm Opens a closed Form attribute object for editing, or adding or deleting pages.
Public Method OpenMasterForm Opens a closed Master Form attribute object for editing, or adding or deleting pages.
Public Method SetPageOptions set a PageRecognitionOptions object in page inside FormRecognitionAttributes and return true if success.
Public Method UpdatePageType This method is used to update internal data after setting the page type using SetPageOptions method.
Public Method UpsertMasterFormToFullTextSearch Adds or updates a master form to the full text search database.

Public Properties

Name Description
Public Property
 FIPSCompatibleMode Enables or disables Compatible with FIPS(Federal Information Processing Standards).
Public Property FullTextSearchManager Full text search manager support.
Public Property FullTextSearchMaximumCandidates The maximum number of matches (candidates) to return.
Public Property FullTextSearchMinimumRank Minimum rank value to be considered a match (or candidate).
Public Property ObjectsManagers Gets a list of object managers that are used to extract the features of the form for this FormRecognitionEngine.
Public Property
static | Shared in VB</div>
 Version The FormRecognitionEngine version to use when recognizing forms.

Public Fields

Name Description
Public Field
 LatestVersion A constant value that indicates the latest version of the forms toolkit.

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

Leadtools.Forms.Recognition Assembly
Introduction
Getting Started
Namespaces
Leadtools.Forms.Recognition Namespace
Assemblies