Class FormPage

Represents a page recognized from the input document. Contains lines, words, tables, selection marks, and page metadata.

Inheritance

System.Object

FormPage

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.FormRecognizer.dll

Syntax

public class FormPage

Properties

Height

The height of the image/PDF in pixels/inches, respectively.

Declaration

public float Height { get; }

Property Value

System.Single

Lines

When 'IncludeFieldElements' is set to true, a list of recognized lines of text. An empty list otherwise. The maximum number of lines returned is 300 per page. The lines are sorted top to bottom, left to right, although in certain cases proximity is treated with higher priority. As the sorting order depends on the detected text, it may change across images and OCR version updates. Thus, business logic should be built upon the actual line location instead of order. For calls to recognize content, this list is always populated and the sorting algorithm for the returned lines can be changed with the option ReadingOrder.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormLine> Lines { get; }

Property Value

System.Collections.Generic.IReadOnlyList<FormLine>

PageNumber

The 1-based page number in the input document.

Declaration

public int PageNumber { get; }

Property Value

System.Int32

SelectionMarks

A list of recognized selection marks contained in this page.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormSelectionMark> SelectionMarks { get; }

Property Value

System.Collections.Generic.IReadOnlyList<FormSelectionMark>

Remarks

This property only has value for V2_1 and up.

Tables

A list of recognized tables contained in this page.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormTable> Tables { get; }

Property Value

System.Collections.Generic.IReadOnlyList<FormTable>

TextAngle

The general orientation of the text in clockwise direction, measured in degrees between (-180, 180].

Declaration

public float TextAngle { get; }

Property Value

System.Single

Unit

The unit used by the width, height and FieldBoundingBox properties. For images, the unit is pixel. For PDF, the unit is inch.

Declaration

public Azure.AI.FormRecognizer.Models.LengthUnit Unit { get; }

Property Value

LengthUnit

Width

The width of the image/PDF in pixels/inches, respectively.

Declaration

public float Width { get; }

Property Value

System.Single