Overloads Overridable Sub Load( _
   ByVal fileName As String _
) 

Visual Basic (Usage)	Copy Code
Dim instance As IOcrSettingManager Dim fileName As String   instance.Load(fileName)

virtual void Load( 
   string fileName
)

virtual void Load( 
   String^ fileName
) 

Parameters

fileName

The name of the file containing the settings.

This example will change some of the settings of the OCR engine and save then to a file. The it shuts down the engine, restarts it and reloads the last settings used.

Visual Basic

Copy Code

Public Sub LoadSettingsExample1()    ' Unlock the support needed for LEADTOOLS Plus OCR engine    RasterSupport.Unlock(RasterSupportType.Document, "Replace with your own key here")    RasterSupport.Unlock(RasterSupportType.OcrPlus, "Replace with your own key here")    RasterSupport.Unlock(RasterSupportType.OcrPlusPdfLeadOutput, "Replace with your own key here")    Dim settingsFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "PlusSettings.xml"    Dim userDictionaryFileName As String = LeadtoolsExamples.Common.ImagesPath.Path + "MyDictionary.ud"    ' Create an instance of the engine    Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)       ' Start the engine using default parameters       ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)       Dim settingManager As IOcrSettingManager = ocrEngine.SettingManager       ' Enable English and German character sets       ocrEngine.LanguageManager.EnableLanguages(New String() {"en", "de"})       ' Set the spell checking options       ocrEngine.SpellCheckManager.Enabled = True       ocrEngine.SpellCheckManager.SpellLanguage = "en"       ocrEngine.SpellCheckManager.UserDictionary.Use(userDictionaryFileName, Nothing)       ' Change some settings       settingManager.SetValue("SaveDocument.FormatLevel", "Part")       settingManager.SetBooleanValue("SaveDocument.Document.TextInBoxes", False)       settingManager.SetIntegerValue("SaveDocument.Document.Margin.Left", 2400)       settingManager.SetStringValue("SaveDocument.Character.ProportionalSansSerifFontName", "MyFont")       settingManager.SetStringValue("SaveDocument.Mark.BeforeMissingCharacterSeparator", "MyMark")       settingManager.SetValue("SaveDocument.Mark.BeginOfLineSeparator", Nothing)       ' Change an enum using an integer       settingManager.SetEnumValue("SaveDocument.Mark.SuspectedCharacterColor", 7)       ' Change an enum using strings       settingManager.SetEnumValue("SaveDocument.Mark.RejectionCharacterColor", "Blue, Green, Red")       ' Save the settings       settingManager.Save(settingsFileName)       ' Note: calling Dispose will also automatically shutdown the engine if it has been started       ocrEngine.Shutdown()    End Using    ' Now create another instance of the engine, load the settings and make sure they are the same    Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, False)       ' Start the engine using default parameters       ocrEngine.Startup(Nothing, Nothing, Nothing, Nothing)       Dim settingManager As IOcrSettingManager = ocrEngine.SettingManager       ' Load the settings       settingManager.Load(settingsFileName)       ' Check the character set       Dim languages() As String = ocrEngine.LanguageManager.GetEnabledLanguages()       Debug.Assert(languages(0) = "en" AndAlso languages(1) = "de")       ' Check the spell checking options       Debug.Assert(ocrEngine.SpellCheckManager.Enabled)       Debug.Assert(ocrEngine.SpellCheckManager.SpellLanguage = "en")       Debug.Assert(ocrEngine.SpellCheckManager.UserDictionary.FileName = userDictionaryFileName)       ' Check the settings       Debug.Assert(settingManager.GetValue("SaveDocument.FormatLevel") = "Part")       Debug.Assert(settingManager.GetBooleanValue("SaveDocument.Document.TextInBoxes") = False)       Debug.Assert(settingManager.GetIntegerValue("SaveDocument.Document.Margin.Left") = 2400)       Debug.Assert(settingManager.GetStringValue("SaveDocument.Character.ProportionalSansSerifFontName") = "MyFont")       Debug.Assert(settingManager.GetStringValue("SaveDocument.Mark.BeforeMissingCharacterSeparator") = "MyMark")       Debug.Assert(settingManager.GetValue("SaveDocument.Mark.BeginOfLineSeparator") = Nothing)       Debug.Assert(settingManager.GetEnumValue("SaveDocument.Mark.SuspectedCharacterColor") = 7)       Debug.Assert(settingManager.GetEnumValueAsString("SaveDocument.Mark.RejectionCharacterColor") = "Blue, Green, Red")       ' Note: calling Dispose will also automatically shutdown the engine if it has been started       ocrEngine.Shutdown()    End Using End Sub

C#

Copy Code

public void LoadSettingsExample1()  {     // Unlock the support needed for LEADTOOLS Plus OCR engine     RasterSupport.Unlock(RasterSupportType.Document, "Replace with your own key here");     RasterSupport.Unlock(RasterSupportType.OcrPlus, "Replace with your own key here");     RasterSupport.Unlock(RasterSupportType.OcrPlusPdfLeadOutput, "Replace with your own key here");     string settingsFileName = LeadtoolsExamples.Common.ImagesPath.Path + "PlusSettings.xml";     string userDictionaryFileName = LeadtoolsExamples.Common.ImagesPath.Path + "MyDictionary.ud";       // Create an instance of the engine     using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false))     {        // Start the engine using default parameters        ocrEngine.Startup(null, null, null, null);          IOcrSettingManager settingManager = ocrEngine.SettingManager;          // Enable English and German character sets        ocrEngine.LanguageManager.EnableLanguages(new string[] { "en", "de" });          // Set the spell checking options        ocrEngine.SpellCheckManager.Enabled = true;        ocrEngine.SpellCheckManager.SpellLanguage = "en";        ocrEngine.SpellCheckManager.UserDictionary.Use(userDictionaryFileName, null);          // Change some settings        settingManager.SetValue("SaveDocument.FormatLevel", "Part");        settingManager.SetBooleanValue("SaveDocument.Document.TextInBoxes", false);        settingManager.SetIntegerValue("SaveDocument.Document.Margin.Left", 2400);        settingManager.SetStringValue("SaveDocument.Character.ProportionalSansSerifFontName", "MyFont");        settingManager.SetStringValue("SaveDocument.Mark.BeforeMissingCharacterSeparator", "MyMark");        settingManager.SetValue("SaveDocument.Mark.BeginOfLineSeparator", null);        // Change an enum using an integer        settingManager.SetEnumValue("SaveDocument.Mark.SuspectedCharacterColor", 7);        // Change an enum using strings        settingManager.SetEnumValue("SaveDocument.Mark.RejectionCharacterColor", "Blue, Green, Red");          // Save the settings        settingManager.Save(settingsFileName);          // Note: calling Dispose will also automatically shutdown the engine if it has been started        ocrEngine.Shutdown();     }       // Now create another instance of the engine, load the settings and make sure they are the same     using(IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.Plus, false))     {        // Start the engine using default parameters        ocrEngine.Startup(null, null, null, null);          IOcrSettingManager settingManager = ocrEngine.SettingManager;          // Load the settings        settingManager.Load(settingsFileName);          // Check the character set        string[] languages = ocrEngine.LanguageManager.GetEnabledLanguages();        Debug.Assert(languages[0] == "en" && languages[1] == "de");          // Check the spell checking options        Debug.Assert(ocrEngine.SpellCheckManager.Enabled);        Debug.Assert(ocrEngine.SpellCheckManager.SpellLanguage == "en");        Debug.Assert(ocrEngine.SpellCheckManager.UserDictionary.FileName == userDictionaryFileName);          // Check the settings        Debug.Assert(settingManager.GetValue("SaveDocument.FormatLevel") == "Part");        Debug.Assert(settingManager.GetBooleanValue("SaveDocument.Document.TextInBoxes") == false);        Debug.Assert(settingManager.GetIntegerValue("SaveDocument.Document.Margin.Left") == 2400);        Debug.Assert(settingManager.GetStringValue("SaveDocument.Character.ProportionalSansSerifFontName") == "MyFont");        Debug.Assert(settingManager.GetStringValue("SaveDocument.Mark.BeforeMissingCharacterSeparator") == "MyMark");        Debug.Assert(settingManager.GetValue("SaveDocument.Mark.BeginOfLineSeparator") == null);        Debug.Assert(settingManager.GetEnumValue("SaveDocument.Mark.SuspectedCharacterColor") == 7);        Debug.Assert(settingManager.GetEnumValueAsString("SaveDocument.Mark.RejectionCharacterColor") == "Blue, Green, Red");          // Note: calling Dispose will also automatically shutdown the engine if it has been started        ocrEngine.Shutdown();     }  }

Once you set up the OCR engine, you can re-use these settings by saving the engine state into memory or to an XML file on disk. You can later reload these settings and use them in the same or different instance of IOcrEngine.

The following table lists all of the states loaded from the XML file. After the load operation completes, some or all of the settings below will be changed.

Part	Members
IOcrSettingManager (accessed through IOcrEngine.SettingManager	All the settings as obtained through IOcrSettingManager.GetSettingNames
IOcrLanguageManager (accessed through IOcrEngine.LanguageManager	The value of IOcrLanguageManager.GetEnabledLanguages
IOcrSpellCheckManager (accessed through IOcrEngine.SpellCheckManager	The values of IOcrSpellCheckManager.Enabled, IOcrSpellCheckManager.SpellLanguage and IOcrSpellCheckManager.UserDictionary.
IOcrDocumentManager (accessed through IOcrEngine.DocumentManager	The values of the IOcrDocumentManager.RejectionSymbol and IOcrDocumentManager.MissingSymbol.

You can save the settings to a disk file using Save, you can load and save the settings into any .NET stream using Load and Save.

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

Reference