LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
GetCharacterValue Method
See Also 
Leadtools.Forms.Ocr Namespace > IOcrSettingManager Interface : GetCharacterValue Method



settingName
Unique setting name. If the IOcrEngine does not support the setting with the unique name settingName, an exception will be thrown. Check which settings the engine supports by using GetSettingNames or IsSettingNameSupported.

The GetCharacterValue Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

settingName
Unique setting name. If the IOcrEngine does not support the setting with the unique name settingName, an exception will be thrown. Check which settings the engine supports by using GetSettingNames or IsSettingNameSupported.
Gets the current value of a character setting.

Syntax

Visual Basic (Declaration) 
Function GetCharacterValue( _
   ByVal settingName As String _
) As Char
Visual Basic (Usage)Copy Code
Dim instance As IOcrSettingManager
Dim settingName As String
Dim value As Char
 
value = instance.GetCharacterValue(settingName)
C# 
char GetCharacterValue( 
   string settingName
)
C++/CLI 
char GetCharacterValue( 
   String^ settingName
) 

Parameters

settingName
Unique setting name. If the IOcrEngine does not support the setting with the unique name settingName, an exception will be thrown. Check which settings the engine supports by using GetSettingNames or IsSettingNameSupported.

Return Value

The current character value of the setting with the unique name settingName.

Example

For an example, refer to IOcrSettingManager.

Remarks

The uniqueName setting must be a "character" type setting, otherwise; this method will throw an exception. To get the type of a setting along with other information such as its friendly name and range use the GetSettingDescriptor method.

To set the value of a character setting, use SetCharacterValue.

You can also set the value of any setting from a string (where the string will be converted to a compatible type) using SetValue. To get the value of any setting as a string, use GetValue. Note that settings of type OcrSettingValueType.BeginCategory and OcrSettingValueType.EndCategory have no values and will throw an exception if you try to get or set their values.

IOcrEngine is a wrapper for different OCR engines. These engines contain specific additional features and functionalities that can be queried and updated using the IOcrSettingManager interface.

You can use the different methods of the IOcrSettingManager interface to get and set the engine-specific settings. Each setting has a unique name (a string value). You can get all the settings available to the current OCR engine through the GetSettingNames method. The GetSettingDescriptor method returns a description of the setting (its type, friendly name and value range), you can then use the various setting get and set methods to query and change the value of a certain setting. For example, if the setting type is OcrSettingValueType.Integer, you can use the GetIntegerValue to get the current value of the setting and the SetIntegerValue to change its value. Refer to IOcrSettingManager for a complete example.

For a list of supported engine-specific settings and their meanings, refer to OCR engine-specific Settings.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

GetCharacterValue requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features