TextFormField Class

Summary

A single rectangular region on a form that defines a text area on a blank (not filled-in) form so a text reading process can be performed on the filled form during form processing.

Syntax

C++/CLI

Java

Python

[SerializableAttribute()] 
public class TextFormField : OcrFormField

[SerializableAttribute()] 
public ref class TextFormField : public OcrFormField

public class TextFormField 
    extends OcrFormField 
    implements java.io.Serializable

class TextFormField(OcrFormField):

Remarks

Fields are defined for each page in the processing engine. All fields require you fill in the Property specifying where the field is located, and a Name Property.

Fields can be added or retrieved through the FormProcessingEngine.Pages property. Once fields are defined, they can be loaded/saved from disk using the FormProcessingEngine.LoadFields and FormProcessingEngine.SaveFields methods, allowing you to define MasterForm fields just once and save them to disk. LEADTOOLS supports TextFormField, OmrFormField, BarcodeFormField, ImageFormField, and custom user-defined fields derived from FormField. When obtaining processing results, check for the type of each field, and cast it to the appropriate type in order to obtain the field-specific results (barcode, image, etc).

Example

Java

using Leadtools; 
using Leadtools.Barcode; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Ocr; 
using Leadtools.Forms.Processing; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Recognition.Barcode; 
using Leadtools.Forms.Recognition.Ocr; 
using Leadtools.Document; 
 
///This example shows how to create a TextFormField. 
public void AddTextFormField(FormProcessingEngine processingEngine) 
{ 
   //Create a new page for the form.  
   FormPage formPage = new FormPage(1, 150, 150); 
   TextFormField textField = new TextFormField(); 
   textField.Name = "Business Name"; 
   textField.Bounds = new LeadRect(196, 327, 1402, 40); 
   formPage.Add(textField); 
   //Add the page to the engine  
   processingEngine.Pages.Add(formPage); 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.FileNotFoundException; 
import java.io.IOException; 
import java.nio.file.Files; 
import java.nio.file.Path; 
import java.nio.file.Paths; 
import java.util.ArrayList; 
import java.util.Scanner; 
import java.util.UUID; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.ocr.*; 
import leadtools.codecs.*; 
import leadtools.document.*; 
import leadtools.forms.common.*; 
import leadtools.forms.processing.*; 
import leadtools.forms.recognition.*; 
import leadtools.forms.recognition.ocr.OcrObjectsManager; 
 
 
public void FormProcessingEngineAddTextFormFieldExample() { 
   FormProcessingEngine processingEngine = new FormProcessingEngine(); 
 
   // Create a new page for the form. 
   FormPage formPage = new FormPage(1, 150, 150); 
   TextFormField textField = new TextFormField(); 
   textField.setName("Business Name"); 
   textField.setBounds(new LeadRect(196, 327, 1402, 40)); 
   formPage.add(textField); 
 
   // Add the page to the engine 
   processingEngine.getPages().add(formPage); 
   assertTrue("Incorrect # of pages", processingEngine.getPages().size() == 1); 
}

Requirements

Target Platforms

Reference

TextFormField Members

Leadtools.Forms.Processing Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Forms.Processing Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Processing Namespace

Assemblies