IOcrSettingManager Interface

Imports Leadtools
Imports Leadtools.Codecs
Imports Leadtools.Forms.Ocr
Imports Leadtools.Forms.DocumentWriters

<TestMethod>
Public Sub OcrSettingManagerExample()
   ' Create an instance of the engine
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Advantage, False)
      ' Start the engine using default parameters
      ocrEngine.Startup(Nothing, Nothing, Nothing, LEAD_VARS.OcrAdvantageRuntimeDir)
      Dim settingManager As IOcrSettingManager = ocrEngine.SettingManager

      ' Dump all the settings supported by this engine to a text file on disk
      DumpAllSettings(settingManager)

      ' Image file to OCR
      Dim tifFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif")

      ' File formats to save
      Dim formats As DocumentFormat() = {DocumentFormat.Text, DocumentFormat.Pdf}

      For Each format As DocumentFormat In formats
         ' Generate the output file name
         Dim outFileName As String = Path.ChangeExtension(tifFileName, DocumentWriter.GetFormatFileExtension(format))

         Console.WriteLine("Format: {0}" & vbLf & "Output file: {1}", format, outFileName)

         Dim detectFontStyles As Integer = 0
         Dim recognizeFontAttributes As Boolean = False

         If format = DocumentFormat.Text Then
            ' This is 'text' format, we dont need to recognize fonts attributes such as bold and italic
            ' This will make the recognition process faster

            Console.WriteLine("Turning off font attributes")

            ' Save the old settings
            detectFontStyles = settingManager.GetEnumValue("Recognition.Fonts.DetectFontStyles")
            recognizeFontAttributes = settingManager.GetBooleanValue("Recognition.Fonts.RecognizeFontAttributes")

            ' Turn them off now
            settingManager.SetEnumValue("Recognition.Fonts.DetectFontStyles", "None")
            settingManager.SetBooleanValue("Recognition.Fonts.RecognizeFontAttributes", False)
         End If

         ' Show the settings we are using
         Console.WriteLine("Recognizing using these font attributes settings:")
         Console.WriteLine("Recognition.Fonts.DetectFontStyles: {0}", _
                           settingManager.GetEnumValueAsString("Recognition.Fonts.DetectFontStyles"))
         Console.WriteLine("Recognition.Fonts.RecognizeFontAttributes: {0}", _
                           settingManager.GetBooleanValue("Recognition.Fonts.RecognizeFontAttributes"))


         ' Recognize and save the file to the output format
         Using ocrDocument As IOcrDocument = ocrEngine.DocumentManager.CreateDocument()
            ' Add a page to the document
            Dim ocrPage As IOcrPage = ocrDocument.Pages.AddPage(tifFileName, Nothing)

            ' Recognize the page
            ' Note, Recognize can be called without calling AutoZone or manually adding zones. The engine will
            ' check and automatically auto-zones the page
            ocrPage.Recognize(Nothing)

            ' Save the document we have as PDF
            ocrDocument.Save(outFileName, format, Nothing)
         End Using

         ' Re-set the original settings
         If format = DocumentFormat.Text Then
            Console.WriteLine("Resetting original settings")
            settingManager.SetEnumValue("Recognition.Fonts.DetectFontStyles", detectFontStyles)
            settingManager.SetBooleanValue("Recognition.Fonts.RecognizeFontAttributes", recognizeFontAttributes)
         End If
      Next

      ' Shutdown the engine
      ' Note: calling Dispose will also automatically shutdown the engine if it has been started
      ocrEngine.Shutdown()
   End Using
End Sub

Private Shared Sub DumpAllSettings(settingManager As IOcrSettingManager)
   ' Write all the settings into a disk file
   Dim settingsFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Settings.txt")
   Using writer As StreamWriter = File.CreateText(settingsFileName)
      writer.WriteLine("Settings")
      Dim settingNames As String() = settingManager.GetSettingNames()

      For Each settingName As String In settingNames
         Dim sd As IOcrSettingDescriptor = settingManager.GetSettingDescriptor(settingName)

         writer.WriteLine("  Name:           {0}", sd.Name)
         writer.WriteLine("  ValueType:      {0}", sd.ValueType)
         writer.WriteLine("  FriendlyName:   {0}", sd.FriendlyName)

         Select Case sd.ValueType
            Case OcrSettingValueType.BeginCategory
               writer.WriteLine("-------------------------------------")
               Exit Select

            Case OcrSettingValueType.[Integer]
               writer.WriteLine("    Units: {0}", sd.Units)
               writer.WriteLine("    IntegerMinimumValue: {0}", sd.IntegerMinimumValue)
               writer.WriteLine("    IntegerMaximumValue: {0}", sd.IntegerMaximumValue)
               Exit Select

            Case OcrSettingValueType.[Enum]
               writer.WriteLine("    EnumIsFlags: {0}", sd.EnumIsFlags)
               writer.WriteLine("    EnumMemberFriendlyNames")
               If True Then
                  Dim values As Integer() = sd.GetEnumMemberValues()
                  Dim names As String() = sd.GetEnumMemberFriendlyNames()
                  For i As Integer = 0 To values.Length - 1
                     writer.WriteLine("      {0} : {1}", names(i), values(i))
                  Next
               End If
               Exit Select

            Case OcrSettingValueType.[Double]
               writer.WriteLine("    Units: {0}", sd.Units)
               writer.WriteLine("    DoubleMinimumValue: {0}", sd.DoubleMinimumValue)
               writer.WriteLine("    DoubleMaximumValue: {0}", sd.DoubleMaximumValue)
               Exit Select

            Case OcrSettingValueType.[Boolean]
               Exit Select

            Case OcrSettingValueType.Character
               Exit Select

            Case OcrSettingValueType.[String]
               writer.WriteLine("    StringMaximumLength:   {0}", sd.StringMaximumLength)
               writer.WriteLine("    StringNullAllowed:     {0}", sd.StringNullAllowed)
               Exit Select

            Case OcrSettingValueType.Rectangle
               Exit Select

            Case OcrSettingValueType.EndCategory
               Exit Select
            Case Else

               Exit Select
         End Select
      Next
   End Using
End Sub

Public NotInheritable Class LEAD_VARS
Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images"
Public Const OcrAdvantageRuntimeDir As String = "C:\LEADTOOLS 19\Bin\Common\OcrAdvantageRuntime"
End Class