Interface IFormRecognizer

Provides methods to recognize forms from an input stream (PDF or image) and return results as a PDF document, PDF stream, or JSON string.

Namespace: Syncfusion.PdfViewer.FormRecognizer

Assembly: Syncfusion.Pdf.Base.dll

Syntax

public interface IFormRecognizer

Remarks

This interface is used by the PDF Viewer Data Extractor feature to identify and extract form fields such as text boxes, check boxes, radio buttons, and signatures, and return the recognized data in JSON format.

Methods

RecognizeFormAsJson(Stream, Dictionary<Int32, List<RectangleF>>, Boolean, Boolean, Boolean, Boolean, Double, Int32[,])

Recognizes the form in pdfStream (PDF or image) and returns the recognition result serialized as a JSON string.

Declaration

string RecognizeFormAsJson(Stream documentStream, Dictionary<int, List<RectangleF>> existingFormFieldBounds, bool detectTextboxes, bool detectCheckboxes, bool detectRadioButtons, bool detectSignatures, double confidenceThreshold, int[, ] pageRange)

Parameters

Type	Name	Description
System.IO.Stream	documentStream	Input stream containing the PDF or image document to analyze.
System.Collections.Generic.Dictionary<System.Int32, System.Collections.Generic.List<System.Drawing.RectangleF>>	existingFormFieldBounds	Optional existing form field bounds to exclude from detection.
System.Boolean	detectTextboxes	Detect textbox form fields. High priority over FormRecognizeOptions.
System.Boolean	detectCheckboxes	Detect checkbox form fields. High priority over FormRecognizeOptions.
System.Boolean	detectRadioButtons	Detect radio button form fields. High priority over FormRecognizeOptions.
System.Boolean	detectSignatures	Detect signature form fields. High priority over FormRecognizeOptions.
System.Double	confidenceThreshold	Confidence threshold for detection. High priority over FormRecognizeOptions.
System.Int32[,]	pageRange	Page range to process. High priority over FormRecognizeOptions.

Returns

Type	Description
System.String	A JSON string describing the recognized form.