menu

File Formats

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class OCRSettings - API Reference

    Show / Hide Table of Contents

    Class OCRSettings

    A class containing the settings of the OCR process.

    Inheritance
    System.Object
    OCRSettings
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.OCRProcessor
    Assembly: Syncfusion.OCRProcessor.Base.dll
    Syntax
    public class OCRSettings

    Constructors

    OCRSettings()

    Declaration
    public OCRSettings()

    Properties

    AutoDetectRotation

    Declaration
    public bool AutoDetectRotation { get; set; }
    Property Value
    Type Description
    System.Boolean

    BlackList

    Gets or sets BlackList values

    Declaration
    public string BlackList { get; set; }
    Property Value
    Type Description
    System.String

    Conformance

    Gets or sets the PDF conformance level

    Declaration
    public PdfConformanceLevel Conformance { get; set; }
    Property Value
    Type Description
    PdfConformanceLevel

    The PdfConformanceLevel ENUM.

    EnableNativeCall

    Enabling this property will process OCR with native calls (PInvoke) instead of surrogate process.

    Declaration
    public bool EnableNativeCall { get; set; }
    Property Value
    Type Description
    System.Boolean

    IsCompressionEnabled

    gets or sets the compression of tiff image

    Declaration
    public bool IsCompressionEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if [compression enable]; otherwise, false.

    IsImageStraighteningEnabled

    Gets or sets the StraightenImage

    Declaration
    public bool IsImageStraighteningEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if [Image straightened]; otherwise, false.

    IsRegionMarked

    Gets or sets the Region marked

    Declaration
    public bool IsRegionMarked { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if [Region marked]; otherwise, false.

    Language

    Gets or sets OCR language

    Declaration
    public string Language { get; set; }
    Property Value
    Type Description
    System.String

    The language to be OCRed

    OCREngineMode

    Gets or sets OCREngineMode

    Declaration
    public OCREngineMode OCREngineMode { get; set; }
    Property Value
    Type Description
    OCREngineMode
    Remarks

    OCREngineMode only supported in Tesseract version 4.0

    PageSegment

    Gets or sets the Page Segment Mode.

    Declaration
    public PageSegmentMode PageSegment { get; set; }
    Property Value
    Type Description
    PageSegmentMode
    Remarks

    PageSegmentMode only supported in Tesseract version 4.0

    Paginate

    Gets or sets the pagination of the images

    Declaration
    public bool Paginate { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if [pagination]; otherwise, false.

    Performance

    Gets or sets the Perfomance of the OCR

    Declaration
    public Performance Performance { get; set; }
    Property Value
    Type Description
    Performance

    Performance of the OCR process

    Regions

    Gets or sets the regions to process OCR

    Declaration
    public List<PageRegion> Regions { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<PageRegion>

    Collection of page regions to apply OCR

    TempFolder

    Declaration
    public string TempFolder { set; }
    Property Value
    Type Description
    System.String

    TesseractVersion

    Declaration
    public TesseractVersion TesseractVersion { get; set; }
    Property Value
    Type Description
    TesseractVersion

    WhiteList

    Gets or sets WhiteList values

    Declaration
    public string WhiteList { get; set; }
    Property Value
    Type Description
    System.String
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved