GetValue Method

Summary

Gets the current value of a setting as a string.

Syntax

Objective-C

C++

Java

public string GetValue( 
   string settingName 
)

Function GetValue( _ 
   ByVal settingName As String _ 
) As String

- (void)setValue:(NSString *)value 
      forSetting:(NSString *)settingName

public String getValue(String settingName)

String^ GetValue(  
   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

The current value of the setting with the unique name settingName as a string.

Remarks

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 setting as a string, use SetValue.

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.

Example

For an example, refer to IOcrSettingManager.

Requirements

Target Platforms

Reference

IOcrSettingManager Interface

IOcrSettingManager Members

IOcrSettingDescriptor Interface

GetSettingNames Method

Programming with the LEADTOOLS .NET OCR

OCR engine-specific Settings

Download our FREE evaluation

Help Version 20.0.2020.4.2