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



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

The GetSettingValueType 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. You can check which settings the engine supports by using GetSettingNames or IsSettingNameSupported
Gets a value indicating the type of the given setting.

Syntax

Visual Basic (Declaration) 
Function GetSettingValueType( _
   ByVal settingName As String _
) As OcrSettingValueType
Visual Basic (Usage)Copy Code
Dim instance As IOcrSettingManager
Dim settingName As String
Dim value As OcrSettingValueType
 
value = instance.GetSettingValueType(settingName)
C# 
OcrSettingValueType GetSettingValueType( 
   string settingName
)
C++/CLI 
OcrSettingValueType GetSettingValueType( 
   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. You can check which settings the engine supports by using GetSettingNames or IsSettingNameSupported

Return Value

A OcrSettingValueType enumeration value indicating the type of the setting with the unique name settingName.

Example

For an example, refer to IOcrSettingManager.

Remarks

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

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