Grooper.OCR.OcrEngine

OCR Engines extract text from images using optical character recognition. Each OCR Profile in Grooper is configured with an OCR Engine. The OCR Engine selection defines the settings which will be exposed to configure the OCR Profile, and controls the runtime component used for text extraction.

NOTE: Some OCR engines require third-party installations and licensing.


Inherits from: Grooper.ConnectedObject

Constructors

Signature Description
New (gdb As GrooperDb) Initializes a new instance of the OcrEngine class.
Parameters
gdb
          Type: GrooperDb
          The Grooper database.

Fields

Field Name Field Type Description
Database As Grooper.GrooperDb Grooper.GrooperDb

Properties

Property Name Property Type Description
HasReferenceProperties System.Boolean Returns true if the object has properties which reference Grooper Node objects.
IsEmpty System.Boolean Returns true if all properties with a ViewableAttribute are set to their default value.
IsWriteable System.Boolean Returns true if the object is writable, or false if it is not.
Root Grooper.GrooperRoot Returns the root node
SupportsContinuousTone System.Boolean Indicates whether the OCR works with color / grayscale images.

Methods

Method Name Description
GetLastError() As String
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
Initialize() As Boolean
IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently enabled.
Parameters
PropertyName
          Type: String
          The name of the property to determine the enabled state for.
IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) Defines whether a property is currently visible.
Parameters
PropertyName
          Type: String
          The name of the property to determine the visible state for.
IsType(Type As Type) As Boolean Returns true if the object is of the type specified, or if it derives from the type specfied.
Parameters
Type
          Type: Type
          The type to check.
OcrImage(Image As GrooperImage, DiagMode As Boolean, ipd As IProgressDisplay) As OcrResults
Parameters
Image
          Type: GrooperImage
          
 
DiagMode
          Type: Boolean
          
 
ipd
          Type: IProgressDisplay
          
ProcessImage(Image As GrooperImage, DiagMode As Boolean, ipd As IProgressDisplay) As OcrResults
Parameters
Image
          Type: GrooperImage
          
 
DiagMode
          Type: Boolean
          
 
ipd
          Type: IProgressDisplay
          
Serialize() As String Serializes the object.
SetDatabase(Database As GrooperDb) Sets the database connection of the object.
Parameters
Database
          Type: GrooperDb
          
SetLastError(Message As String, pa() As Object())
Parameters
Message
          Type: String
          
 
pa
          Type: Object
          
ToString() As String Returns a string value representation of the connected object.
UnInitialize() As Boolean
ValidateProperties() As ValidationErrorList Validates the properties of the object, returning a list of validation errors.