Search Results for

    Show / Hide Table of Contents

    Class OcrResult.Page

    Represents a single page within an OcrResult object.

    Inheritance
    System.Object
    OcrResult.OcrResultElement
    OcrResult.OcrResultTextElement
    OcrResult.Page
    Implements
    IronSoftware.IDocumentTextObject
    IronSoftware.IBoundedDocumentObject
    IronSoftware.IDocumentObject
    IronSoftware.IBounded
    IronSoftware.ITransformable
    IronSoftware.IColored
    System.ICloneable
    IronSoftware.Abstractions.IDocumentPage<IOcrPageObjectModel>
    IronSoftware.Abstractions.IPageContainer
    Inherited Members
    OcrResult.OcrResultTextElement.ToString()
    OcrResult.OcrResultTextElement.Clone()
    OcrResult.OcrResultTextElement.TextDirection
    OcrResult.OcrResultTextElement.Text
    OcrResult.OcrResultTextElement.PdfDocumentId
    OcrResult.OcrResultTextElement.ObjNum
    OcrResult.OcrResultTextElement.Contents
    OcrResult.OcrResultTextElement.Left
    OcrResult.OcrResultTextElement.Right
    OcrResult.OcrResultTextElement.Top
    OcrResult.OcrResultTextElement.Bottom
    OcrResult.OcrResultTextElement.Color
    OcrResult.OcrResultTextElement.BoundingBox
    OcrResult.OcrResultTextElement.Scale
    OcrResult.OcrResultTextElement.Translate
    OcrResult.OcrResultTextElement.Matrix
    OcrResult.OcrResultTextElement.Font
    OcrResult.OcrResultTextElement.FontSize
    OcrResult.OcrResultTextElement.RenderMode
    OcrResult.OcrResultTextElement.DocumentId
    OcrResult.OcrResultTextElement.FillColor
    OcrResult.OcrResultTextElement.StrokeColor
    OcrResult.OcrResultTextElement.IsBold
    OcrResult.OcrResultTextElement.IsItalic
    OcrResult.OcrResultElement.ToBitmap(OcrInput)
    OcrResult.OcrResultElement.X
    OcrResult.OcrResultElement.Y
    OcrResult.OcrResultElement.Location
    Namespace: IronOcr
    Assembly: IronOcr.dll
    Syntax
    public class Page : OcrResult.OcrResultTextElement, IDocumentTextObject, IBoundedDocumentObject, IDocumentObject, IBounded, ITransformable, IColored, ICloneable, IDocumentPage<IOcrPageObjectModel>, IPageContainer

    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
    OcrResult.OcrResultTextElement.Confidence

    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 IronOcr.OcrInput.AddImage(IronSoftware.Drawing.AnyBitmap,IronSoftware.Drawing.Rectangle)

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

    Height

    Declaration
    public double Height { get; }
    Property Value
    Type Description
    System.Double

    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[]

    ObjectModel

    Declaration
    public IOcrPageObjectModel ObjectModel { get; }
    Property Value
    Type Description
    IOcrPageObjectModel

    PageIndex

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

    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[]

    Rotation

    The number of degrees the original page has been rotated to produce this result.

    Declaration
    public double Rotation { get; }
    Property Value
    Type Description
    System.Double

    Tables

    Represents every Grouping of Lines that can represent a table.

    Declaration
    public OcrResult.Table[] Tables { get; }
    Property Value
    Type Description
    OcrResult.Table[]

    Width

    Declaration
    public double Width { get; }
    Property Value
    Type Description
    System.Double

    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 AnyBitmap ContentAreaToBitmap(OcrInput Input)
    Parameters
    Type Name Description
    OcrInput Input

    The OcrInput document that was read by IronTesseract

    Returns
    Type Description
    IronSoftware.Drawing.AnyBitmap

    A IronSoftware.Drawing.AnyBitmap.

    Implements

    IronSoftware.IDocumentTextObject
    IronSoftware.IBoundedDocumentObject
    IronSoftware.IDocumentObject
    IronSoftware.IBounded
    IronSoftware.ITransformable
    IronSoftware.IColored
    System.ICloneable
    IronSoftware.Abstractions.IDocumentPage<>
    IronSoftware.Abstractions.IPageContainer

    Inherited members

    ToString()
    Clone()
    TextDirection
    Text
    PdfDocumentId
    ObjNum
    Contents
    Left
    Right
    Top
    Bottom
    Color
    BoundingBox
    Scale
    Translate
    Matrix
    Font
    FontSize
    RenderMode
    DocumentId
    FillColor
    StrokeColor
    IsBold
    IsItalic
    ToBitmap(OcrInput)
    X
    Y
    Location
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronOCR to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronOCR free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.