Click or drag to resize

Character Class

The Character object provides information about a single recognized character, such as the character code, coordinates of the character on the image, confidence information etc.
Inheritance Hierarchy

Namespace:  Kofax.OmniPageCSDK.IproPlus
Assembly:  Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntax
public class Character : IproPlusClass, IDisposable

The Character type exposes the following members.

Properties
  NameDescription
Public propertyBackColor
This property returns the background color of the character.
Public propertyBase
This property returns the Y coordinate of the baseline measured in TWIPS from the top edge of the page.
Public propertyCertainWord
This property returns True if the word containing this character is a certain word (safely recognized).
Public propertyCode
This property returns the character code in UNICODE.
Public propertyConfidence
This property returns the confidence number expressing the certainty of the recognition of the first guess (Code property).
Public propertyData
This property returns the data attribute flags of the recognized character.
Public propertyFont
This property returns the font formatting attribute flags of the recognized character. It can be a bit-wise combination of the following value set:
Public propertyFontSize
This property returns the font size of the character measured in points.
Public propertyForeColor
This property returns the foreground color of the character.
Public propertyGuesses
This property returns the character-guess codes.
Public propertyHeight
This property returns the Height of the rectangle exactly containing the character measured in TWIPS.
Public propertyLanguage
This property returns the language of the recognized word containing this character.
Public propertyLanguage2
This property contains the ID of the secondary language if the recognized word was found in multiple language dictionaries.
Public propertyleft
This property returns the X coordinate of the rectangle's left edge exactly containing the character measured in TWIPS.
Public propertySuggestions
This property returns a word suggestion list if available provided that the particular character is the leading character of a word.
Public propertytop
This property returns the Y coordinate of the rectangle's top edge exactly containing the character measured in TWIPS.
Public propertyWidth
This property returns the width of the rectangle exactly containing the character measured in TWIPS.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the Character
Public methodGetDocument
Returns the parent Document object.
Public methodGetEngine
Returns the Engine object.
Public methodGetSpaceInfo
This method returns information about a space filling character.
Top
Remarks

The character coordinates are treated as OCR image coordinates.

See Also