←Select platform

GetSettingDescriptor Method

Summary

Gets the descriptor of the given setting.

Syntax

Java

Objective-C

WinRT C#

C++

public IOcrSettingDescriptor GetSettingDescriptor( 
   string settingName 
)

Function GetSettingDescriptor( _ 
   ByVal settingName As String _ 
) As Leadtools.Forms.Ocr.IOcrSettingDescriptor

Leadtools.Forms.Ocr.IOcrSettingDescriptor GetSettingDescriptor(  
   string settingName 
)

- (LTOcrSettingDescriptor *)descriptorForSetting:(NSString *)settingName

public OcrSettingDescriptor getSettingDescriptor(String settingName)

function Leadtools.Forms.Ocr.IOcrSettingManager.GetSettingDescriptor(  
   settingName  
)

Leadtools.Forms.Ocr.IOcrSettingDescriptor^ GetSettingDescriptor(  
   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

An instance of IOcrSettingDescriptor that describe the type of the setting with the unique name settingName.

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.

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

Help Version 19.0.2017.10.27