Class OcrResult.Page

Represents a single page within an OcrResult object.

Inheritance
System.Object
OcrResult.OcrResultElement
OcrResult.OcrResultTextElement
OcrResult.Page
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class Page : OcrResult.OcrResultTextElement

Fields

PdfExtractedText

When Reading PDFs. Gives an alternative value to Text which comes from machine decoding PDF document strings only. Can not read text from images.

Declaration
public string PdfExtractedText
Field Value
Type Description
System.String

Properties

Barcodes

Represents every barcode discovered in this Page. Developers must set ReadBarCodes = True for this feature to be active.

Declaration
public OcrResult.Barcode[] Barcodes { get; }
Property Value
Type Description
OcrResult.Barcode[]

Blocks

Represents every block of text discovered within this OcrResult.Page in order of appearance.

Declaration
public OcrResult.Block[] Blocks { get; }
Property Value
Type Description
OcrResult.Block[]

Characters

Represents every symbol (char) discovered within this OcrResult.Page in order of appearance.

Declaration
public OcrResult.Character[] Characters { get; }
Property Value
Type Description
OcrResult.Character[]

Confidence

OCR statistical accuracy confidence as an average of every character.

1 = 100%, 0 = 0%

Declaration
public override double Confidence { get; }
Property Value
Type Description
System.Double
Overrides

ContentArea

Represents the rectangular area of this OcrResult.Page page on which OCR has been applied. Dimensions are in Pixels.

Default value is the entire size of the Page. Relates to AddImage(Bitmap, Rectangle)

Declaration
public Rectangle ContentArea { get; set; }
Property Value
Type Description
System.Drawing.Rectangle

Lines

Represents every line of text discovered within this OcrResult.Page in order of appearance.

Declaration
public OcrResult.Line[] Lines { get; }
Property Value
Type Description
OcrResult.Line[]

PageNumber

A 1 based unique identifier for this page within an OcrResult object. The first page is number 1.

Declaration
public int PageNumber { get; }
Property Value
Type Description
System.Int32

Paragraphs

Represents every paragraph of text discovered within this OcrResult.Page in order of appearance.

Declaration
public OcrResult.Paragraph[] Paragraphs { get; }
Property Value
Type Description
OcrResult.Paragraph[]

WordCount

The number of words on this page.

Declaration
public int WordCount { get; }
Property Value
Type Description
System.Int32

Words

Represents every word discovered within this OcrResult.Page in order of appearance.

Declaration
public OcrResult.Word[] Words { get; }
Property Value
Type Description
OcrResult.Word[]

Methods

ContentAreaToBitmap(OcrInput)

Returns an image of the ContentArea of this OcrResult.Page.

Declaration
public Bitmap ContentAreaToBitmap(OcrInput Input)
Parameters
Type Name Description
OcrInput Input

The OcrInput document that was read by IronTesseract
Returns
Type Description
System.Drawing.Bitmap

A System.Drawing.Bitmap which should be correctly disposed.