←Select platform
FormRecognitionEngine Class Members
Summary
The following tables list the members exposed by FormRecognitionEngine.
Public Constructors
| Name | Description | |
|---|---|---|
 |
FormRecognitionEngine | Initializes a new FormRecognitionEngine class object. |
Public Methods
| Name | Description | |
|---|---|---|
 |
AddFormPage | Appends a new page to the specified Form attributes object. The Form attributes object should be opened before the addition using OpenForm. |
|
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. |
|
CloseForm | Closes an open FormRecognitionAttributes object associated with a Form. |
|
CloseMasterForm | Closes an open FormRecognitionAttributes object associated with a Master Form. |
|
CompareExtendedForm | Returns a FormRecognitionResult object determines how close is the specified Form to the specified Master Form. |
|
CompareForm | Returns a FormRecognitionResult object determines how close is the specified Form to the specified Master Form. |
|
CompareFormFast | Returns a FormRecognitionResult object determines how close is the specified Form to the specified Master Form. |
|
ComparePage | Returns a PageRecognitionResult object that describes how close the specified Form page is in comparison to the specified Master Form page. |
|
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. |
|
CreateMasterForm | Creates a new Master Form attribute object with the specified options. |
|
DeleteFormPage | Deletes the specified page from the specified Form attribute object. |
|
DeleteMasterFormFromFullTextSearch | Deletes master form (by name) from the full text search database. |
|
DeleteMasterFormPage | Deletes the specified page from the specified Master Form. |
|
FillFieldsInformation | Update passed Leadtools.Forms.Processing.FormPages by filling Extra-information after recognition phase but before Processing phase. |
|
GetFormAlignment | Returns a list of Leadtools.Forms.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. |
|
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. |
|
GetFullTextSearchCandidatesForm | Finds all the master form candidates for a form using full text search. |
|
GetFullTextSearchCandidatesPage | Finds all the master form candidates for a form page using full text search. |
|
GetPageAlignment | Returns a Leadtools.Forms.PageAlignment object which specifies the amount of shift and scaling for a specific form page, according to the specified Master Form. |
|
GetPageOptions | Returns a PageRecognitionOptions object from specific page number in FormRecognitionAttributes. |
|
InsertFormPage | Appends a new page to the specified Form attributes object. The Form attributes object should be opened before the addition using OpenForm. |
|
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. |
|
IsMasterFormInFullTextSearch | Detects if the master form has been added to the full text database. |
|
OpenForm | Opens a closed Form attribute object for editing, or adding or deleting pages. |
|
OpenMasterForm | Opens a closed Master Form attribute object for editing, or adding or deleting pages. |
|
SetPageOptions | set a PageRecognitionOptions object in page inside FormRecognitionAttributes and return true if success. |
|
UpdatePageType | This method is used to update internal data after setting the page type using SetPageOptions method. |
|
UpsertMasterFormToFullTextSearch | Adds or updates a master form to the full text search database. |
Public Properties
| Name | Description | |
|---|---|---|
 |
FIPSCompatibleMode | Enables or disables Compatible with FIPS(Federal Information Processing Standards). |
|
FullTextSearchManager | Full text search manager support. |
|
FullTextSearchMaximumCandidates | The maximum number of matches (candidates) to return. |
|
FullTextSearchMinimumRank | Minimum rank value to be considered a match (or candidate). |
|
ObjectsManagers | Gets a list of object managers that are used to extract the features of the form for this FormRecognitionEngine. |
