ICharacterParams - ABBYY Documentation

Stores information about character properties.

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

Method	Description
`SetRect( newRect : string, [optional] pageId : int )` *	Specifies a new rectangle for a character. The `newRect` parameter must be passed as the string `[left, top, right, bottom]`. The specified rectangle must be completely inside the region of the field that contains the character. 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`. Using this property requires storing additional data, which may increase document size and disk usage. By default, no additional data is saved and the property is disabled. To enable it, set the registry key `[HKEY_CURRENT_USER\Software\ABBYY\FlexiCapture\12.0\Controller]` value `"ForceSaveConfidenceLevel" = "true"`. Instead of `HKEY_CURRENT_USER`, select the branch of the user account that will recognize documents.
IsSuspicious *	bool	Read/write	Specifies whether a character has been recognized with a sufficient degree of confidence. This flag is effective only in the custom recognition script. A recognition script that assigns `IsSuspicious` to a character makes ABBYY FlexiCapture check that character’s field against the field verification threshold. If the percentage of characters with the `IsSuspicious` property in the field exceeds the specified threshold, the `NeedVerification` property is added to the field.
Lang *	int	Read/write	Detects the language of characters in a field. For an example, see Detect the language of each character.
NeedVerification	bool	Read/write	Specifies whether additional verification is required for the character. The value of this flag determines whether the character is highlighted in the document editor. Any script other than a recognition script that assigns `NeedVerification` to a field marks that field as sent to verification. ABBYY FlexiCapture checks the field verification threshold (see the note for the `IsSuspicious` property) before 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).

Detect the language of each character

The following on-user-command script detects the language of each character in the field. It writes the detected languages in a comment on the page. It processes only the selected documents at the verification stage.

ITaskWindow taskWindow = MainWindow.TaskWindow;
ISelection selection = MainWindow.Selection;
IDocumentItems items = selection.DocumentItems;
foreach( IDocumentItem item in items ) {
    IDocument doc = item.Document;
    taskWindow.OpenDocument(doc);
    foreach (IPage page in doc.Pages) {
    IField field = doc.Field("Field Name");
    ICharactersParams characterParams = field.Symbols;
    string str = "";
    foreach( ICharacterParams param in characterParams ) {
        str = str + " " + param.Lang.ToString();
    }
    page.Comment = str;
    }
}