Search Results for

    Show / Hide Table of Contents

    Class OcrInputPage

    A full page (one image) within an OcrInput object.

    Inheritance
    System.Object
    OcrInputPage
    OcrInput.Page
    Namespace: IronOcr
    Assembly: IronOcr.dll
    Syntax
    public class OcrInputPage : Object

    Properties

    ContentArea

    Crop area of this page. If not null, text will only be read from within the ContentArea rectangle.

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

    Height

    Height in Pixels

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

    HorizontalDPI

    Resolution in DPI on X axis

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

    Index

    Zero based page number

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

    VerticalDPI

    Resolution in DPI on Y axis

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

    Width

    Width in Pixels

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

    Methods

    DrawRectanglesOnPage(Rectangle[], Color)

    Draw many Rectangles on a OcrInputPage.

    Declaration
    public AnyBitmap DrawRectanglesOnPage(Rectangle[] CropRects, Color rectangleColor)
    Parameters
    Type Name Description
    IronSoftware.Drawing.Rectangle[] CropRects

    Crop Rectangle

    IronSoftware.Drawing.Color rectangleColor

    Color for pen of rectangle border

    Returns
    Type Description
    IronSoftware.Drawing.AnyBitmap

    Bitmap

    FindMultipleTextRegions()

    Use computer vision to detect areas which contain text elements and divide the page into separate images based on text regions.

    Declaration
    public List<OcrInputPage> FindMultipleTextRegions()
    Returns
    Type Description
    System.Collections.Generic.List<OcrInputPage>

    List of rectangles which contain text elements

    Remarks

    Useful for generating several OCR results from a single image/page

    FindTextRegion()

    Use computer vision to detect regions which contain text elements and instruct Tesseract to only search for text within the area in which text was detected.

    Declaration
    public Rectangle FindTextRegion()
    Returns
    Type Description
    IronSoftware.Drawing.Rectangle

    Rectangle which contains text elements

    GetCropRectangleImage()

    Draw a Rectangle on a OcrInputPage.

    Declaration
    public AnyBitmap GetCropRectangleImage()
    Returns
    Type Description
    IronSoftware.Drawing.AnyBitmap

    Bitmap

    GetTextRegions()

    Use computer vision to detect areas which contain text elements and return a list of rectangles.

    Declaration
    public List<Rectangle> GetTextRegions()
    Returns
    Type Description
    System.Collections.Generic.List<IronSoftware.Drawing.Rectangle>

    List of rectangles which contain text elements

    Remarks

    Useful for generating several OCR results from a single image/page

    SaveAsImage(String)

    Saves this page as a Bitmap file to a specified path.

    A file path.
    Declaration
    public void SaveAsImage(string Path)
    Parameters
    Type Name Description
    System.String Path

    SaveAsImage(String, AnyBitmap.ImageFormat)

    Saves this page as an image file of specified format.

    A file path. The desired image file format.
    Declaration
    public void SaveAsImage(string Path, AnyBitmap.ImageFormat Format)
    Parameters
    Type Name Description
    System.String Path
    IronSoftware.Drawing.AnyBitmap.ImageFormat Format

    ToBitmap()

    Outputs this page as a IronSoftware.Drawing.AnyBitmap

    Declaration
    public AnyBitmap ToBitmap()
    Returns
    Type Description
    IronSoftware.Drawing.AnyBitmap

    A native bitmap image.

    ☀
    ☾
    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.