SpellLanguage Property

Summary

Gets or sets a value that indicate the current language (dictionary) to use for spell checking.

Syntax

C++/CLI

Java

Python

public string SpellLanguage { get; set; }

public String getSpellLanguage() 
public void setSpellLanguage(String value)

property String^ SpellLanguage { 
   String^ get(); 
   void set (    String^ ); 
}

SpellLanguage # get and set (IOcrSpellCheckManager)

Property Value

A String value that represent the name of the language (dictionary) to use for spell checking.

Remarks

The OcrEngineType.LEAD engine supports multiple spell check languages and the engine automatically loads the language dictionaries based on the language(s) currently enabled in IOcrLanguageManager. Important: SpellLanguage is not used and will have no effect.

The name of the spelling language should be in the same format used in specifying character set languages as described in IOcrLanguageManager. Once you set a spell language and assuming the spell checking system is enabled, the engine will now use this language dictionary to check and correct the spelling of the recognized text.

You can get the names of the spelling languages supported by the system with the GetSupportedSpellLanguages method. The available languages (dictionaries) depends on the current spell check engine set in SpellCheckEngine.

In addition to the values returned by GetSupportedSpellLanguages, you can use the following special string case-sensitive values:

Value	Description
A null (Nothing in Visual Basic) string reference	Automatic spell language selection. If only one language has been enabled in the language environment with the IOcrLanguageManager.EnableLanguages method, then this language will be automatically selected for spelling too providing it is one of the languages supported by the spelling check system (one of the values returned by GetSupportedSpellLanguages).
none	The checking subsystem will not use the Language dictionary at all.

For more information about the spell checking system, refer to IOcrSpellCheckManager.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Ocr; 
using Leadtools.Drawing; 
 
public void OcrSpellCheckManagerExample() 
{ 
   // Create an instance of the engine 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      // Start the engine using default parameters 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
      IOcrSpellCheckManager spellCheckManager = ocrEngine.SpellCheckManager; 
 
      // Get the spell language supported (languages with a dictionary) 
      string[] spellLanguages = spellCheckManager.GetSupportedSpellLanguages(); 
      foreach (string spellLanguage in spellLanguages) 
         Console.WriteLine(spellLanguage); 
 
      // Check if English is supported 
      string language = "en"; 
      if (spellCheckManager.IsSpellLanguageSupported(language)) 
      { 
         // Yes, set it 
         spellCheckManager.SpellLanguage = language; 
         Console.WriteLine("Current spell language: {0}", spellCheckManager.SpellLanguage); 
      } 
 
      // Enable the spell checking system 
      spellCheckManager.SpellCheckEngine = OcrSpellCheckEngine.Native; 
 
      // Now perform other OCR functions here 
 
      // Shutdown the engine 
      // Note: calling Dispose will also automatically shutdown the engine if it has been started 
      ocrEngine.Shutdown(); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS23\Bin\Common\OcrLEADRuntime"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.ocr.*; 
 
 
public void IOcrSpellCheckManagerExample() { 
   final String OCR_LEAD_RUNTIME_DIR = "C:\\LEADTOOLS23\\Bin\\Common\\OcrLEADRuntime"; 
   OcrEngine ocrEngine = OcrEngineManager.createEngine(OcrEngineType.LEAD); 
 
   // Start the engine using default parameters 
   ocrEngine.startup(null, null, null, OCR_LEAD_RUNTIME_DIR); 
   assertTrue("OCR engine failed to start", ocrEngine.isStarted()); 
 
   OcrSpellCheckManager spellCheckManager = ocrEngine.getSpellCheckManager(); 
 
   // Get the spell language supported (languages with a dictionary) 
   String[] spellLanguages = spellCheckManager.getSupportedSpellLanguages(); 
   for (var spellLanguage : spellLanguages) 
      System.out.println(spellLanguage); 
 
   // Check if English is supported 
   String language = "en"; 
   if (spellCheckManager.isSpellLanguageSupported(language)) { 
      // Yes, set it 
      spellCheckManager.setSpellLanguage(language); 
      System.out.println("Current spell language: " + spellCheckManager.getSpellLanguage()); 
   } 
 
   // Enable the spell checking system 
   spellCheckManager.setSpellCheckEngine(OcrSpellCheckEngine.NATIVE); 
   assertTrue("Spell checking system unsuccessfully enabled", spellCheckManager.getSpellCheckEngine() == OcrSpellCheckEngine.NATIVE); 
 
   // Shutdown the engine 
   // Note: calling Dispose will also automatically shutdown the engine if it has 
   // been started 
   ocrEngine.shutdown(); 
   ocrEngine.dispose(); 
}