ICharacterParams

What it does

Stores information about character properties.

Note. Some methods and properties of this object are not available on the Web Verification Station for checking rules locally. The methods and properties that are not supported are marked with an asterisk (*).

Methods

Definition Description
SetRect( newRect : string, [optional] pageId : int ) *

Specifies a new rectangle for a character. The newRect parameter must be passed in the form of the string "[left, top, right, bottom]".

The specified rectangle must be completely inside the region of the field that contains the character.

Note: This method is not available in the autocorrection script.

Properties

Name Type Access Description
Confidence * int Read-only

Confidence level for a batch type. Returns a value from 0 to 100.

Important! Using this property requires storing some additional data, which may increase the size of a document and additional disk space. By default, no additional data are saved and the property is disabled. For the correct operation of the property, set the registry key [HKEY_CURRENT_USER\Software\ABBYY\FlexiCapture\12.0\Controller] "ForceSaveConfidenceLevel" = "true". Instead of HKEY_CURRENT_USER, select the branch of the user account that will recognize documents.

IsSuspicious * bool Read/write

Specifies whether or not a character has been recognized with a sufficient degree of confidence. This flag is effective only in the custom recognition script.

Note: When the IsSuspicious property is assigned to a character by a recognition script, the program will check the field containing this character against the field verification threshold. If the percentage of characters with the IsSuspicious property in the field exceeds the specified threshold, the NeedVerification property will be added to the field.

Lang * int Read/write

Detects the language of characters in a field.

Example

Note: This script will process only selected documents at the verification stage.

NeedVerification bool Read/write

Specifies whether any additional verification is required for the character. The value of this flag determines whether the character will be highlighted in the document editor.

Note: When the NeedVerification property is assigned to a field by any script other than a recognition script, the field is automatically marked as sent to verification. The program checks the field verification threshold (see the note for the IsSuspicious property) prior to allocating the NeedVerification property.

To specify, whether the whole field (not particular characters) needs verification, use the NeedVerification property of the IField interface.

PageId * int Read-only Identifies the page on which the rectangle of the character is located. Required for multi-page fields.
Rect * IRect Read-only A rectangle that contains the character. If the rectangle is not specified, null is returned.
Symbol string Read/write A character (a string consisting of one character).

12/1/2020 7:03:59 AM


Please leave your feedback about this article