CHR_FILTER Enumeration |
Namespace: Kofax.OmniPageCSDK.IproPlus
Assembly: Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
SyntaxMembers| Member name | Value | Description | |
|---|---|---|---|
| FILTER_DEFAULT | 0 | The zone should be handled globally. Do not combine this with any other filter. | |
| FILTER_DIGIT | 1 | [Disjunct filter] Recognition of numerals. E.g.: "3" (Digit Three). | |
| FILTER_UPPERCASE | 2 | [Disjunct filter] Recognition of uppercase letters, including accented ones. E.g.: "A" | |
| FILTER_LOWERCASE | 4 | [Disjunct filter] Recognition of lowercase letters, including accented ones. E.g.: "a" | |
| FILTER_PUNCTUATION | 8 | [Disjunct filter] Recognition of punctuation signs. E.g.: "!" | |
| FILTER_MISCELLANEOUS | 16 | [Disjunct filter] Recognition of miscellaneous characters. E.g.: "+" | |
| FILTER_PLUS | 32 | Enables the use of the FilterPlus characters for the zone. The FilterPlus characters can be specified or obtained through the FilterPlus property of the Document object. (i.e. Enabling individually defined characters after other filtering effects.) | |
| FILTER_USER_DICT | 64 | Recognition of characters from the selected section of the user dictionary assigned in the zone. | |
| FILTER_ALL | 31 | [Pre-defined combined filter] Since all elements are enabled, there is no filtering. | |
| FILTER_ALPHA | 6 | [Pre-defined combined filter] Recognition of upper and lowercase letters only. | |
| FILTER_NUMBERS | 33 | [Pre-defined combined filter] Recognition of numerals plus the FilterPlus characters specified in the FilterPlus property of the Document object. | |
| FILTER_SIZE | 128 | Number of possible combinations of the disjunct filters. |
RemarksThis enum lists available Character Set filter elements. Language environment can be narrowed down by specifying Character Set filters. The name of each filter element denotes the category of characters it validates. A filter is built from one or more filter elements by combining (binary OR-ing) them. There are five disjunct elements, a special one and some pre-defined, combined ones. The filters can have an effect either at zone level or globally, at document level. Use the value FILTER_ALL to set no filtering.
Characters in the document that are not part of the specified Character Set will either be rejected or will be recognized as a validated character with a similar shape. For instance, if you select English only and the document contains a letter "Capital A with acute", the recognized output will be the letter "Capital A".
The capabilities of the selected recognition module can also impose restrictions, e.g. the HNR module is restricted to numerals and four other characters.
Not all recognition modules support all filter elements:
- The ones that support all filter elements are: RM_OMNIFONT_MOR, RM_RER, RM_DOT, RM_OMNIFONT_FRX.
- The ones that ignore all filter elements are: RM_BAR, RM_OMR.
- The ones that support some filter elements are: RM_OMNIFONT_PLUS2W, RM_OMNIFONT_PLUS3W and RM_OMNIFONT_MTX (FILTER_ALL, FILTER_DIGIT and FILTER_ALPHA), RM_HNR (FILTER_ALL, FILTER_DIGIT, FILTER_PUNCTUATION and FILTER_MISCELLANEOUS).
To add FILTER_PLUS characters to the Character Set defined by the language environment, the filter value should be: FILTER_ALL | FILTER_PLUS.
To add FILTER_PLUS characters to the filtered Character Set, place FILTER_PLUS along with the other required filters. For example, to enable only digits and FILTER_PLUS characters, use: FILTER_DIGIT | FILTER_PLUS.
To validate FILTER_PLUS characters only, FILTER_PLUS must be the only filter element. This even prevents language selection from validating letters in the current zone.
See Also