C#
VB
Java
Objective-C
WinRT C#
C++
←Select platform
IOcrSettingDescriptor Interface
Summary
Defines a setting name, friendly name, type and range.
Syntax
Remarks
IOcrSettingDescriptor contains the properties of a setting. You can get the settings supported by the OCR engine by calling IOcrSettingManager.GetSettingNames and you can get the descriptor (an instance of IOcrSettingDescriptor) of a setting by calling IOcrSettingManager.GetSettingDescriptor.
The following table lists the members of IOcrSettingDescriptor and their meaning:
| Member | Description | Valid For |
|---|---|---|
| IOcrSettingDescriptor.Name | The unique name of setting. This is the same name you pass to IOcrSettingManager.GetSettingDescriptor | All types |
| IOcrSettingDescriptor.ValueType | One of the OcrSettingValueType enumeration member specifying the setting type | All types |
| IOcrSettingDescriptor.FriendlyName | Friendly name of the setting. You can use this name in your user application | All types |
| IOcrSettingDescriptor.Units | Name of the unit of the value | OcrSettingValueType.Integer and OcrSettingValueType.Double |
| IOcrSettingDescriptor.IntegerMinimumValue | Minimum allowed value of the setting | OcrSettingValueType.Integer |
| IOcrSettingDescriptor.IntegerMaximumValue | Maximum allowed value of the setting | OcrSettingValueType.Integer |
| IOcrSettingDescriptor.EnumIsFlags | If true, the enum setting members can be combined together (OR'ed), otherwise; only one enum member can be set at a time | OcrSettingValueType.Enum |
| IOcrSettingDescriptor.GetEnumMemberFriendlyNames | Returns an array of strings containing the enumeration members friendly names. You can use these name in your user application | OcrSettingValueType.Enum |
| IOcrSettingDescriptor.GetEnumMemberValues | Returns an array of integers containing the enumeration members values | OcrSettingValueType.Enum |
| IOcrSettingDescriptor.DoubleMinimumValue | Minimum allowed value of the setting | OcrSettingValueType.Double |
| IOcrSettingDescriptor.DoubleMaximumValue | Maximum allowed value of the setting | OcrSettingValueType.Double |
| IOcrSettingDescriptor.StringMaximumLength | Maximum number of characters in the value of the setting | OcrSettingValueType.String |
| IOcrSettingDescriptor.StringNullAllowed | A null (Nothing in Visual Basic) is a valid value for this setting | OcrSettingValueType.String |
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 IOcrSettingManager.GetSettingNames method. The IOcrSettingManager.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 IOcrSettingManager.GetIntegerValue to get the current value of the setting and the IOcrSettingManager.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
