Class OcrResult.Word
Represents a Word discovered during OCR.
Implements
Inherited Members
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public class Word : OcrResult.OcrResultTextElementReading a single recognized word, with its characters and its place in the page layout, runs through OcrResult.Word. It is the finest text grouping above individual characters, the level most extraction code iterates when it wants words plus their position and confidence.
Words arrive from a page: OcrResult.Page.Words returns an array of Word in reading order. Each word derives from OcrResult.OcrResultTextElement, so you read Text, Confidence, BoundingBox, and Color from the shared base, then use the word-specific members to navigate the structure around it.
Characters is the array of OcrResult.Character that make up the word, in order, for character-level work. WordNumber is a 1 based identifier within the result. The navigation members point back up the layout tree: Line, Paragraph, and Block give the containing OcrResult.Line, OcrResult.Paragraph, and OcrResult.Block, so you can ask which line or paragraph a word belongs to. Font reports an OcrResult.OcrFont but is legacy and null unless the Tesseract 3 engine mode is used, so do not rely on it for current reads.
The OCR results objects example walks words and their parents, and the reading results how-to shows how to read word text, confidence, and position.
Fields
Block
The Block containing this Word.
Declaration
public OcrResult.Block BlockField Value
| Type | Description |
|---|---|
| OcrResult.Block |
Line
The Line containing this Word.
Declaration
public OcrResult.Line LineField Value
| Type | Description |
|---|---|
| OcrResult.Line |
Paragraph
The Paragraph containing this Word.
Declaration
public OcrResult.Paragraph ParagraphField Value
| Type | Description |
|---|---|
| OcrResult.Paragraph |
Properties
Characters
A list of every symbol (char) within this word in order.
Declaration
public OcrResult.Character[] Characters { get; }Property Value
| Type | Description |
|---|---|
| OcrResult.Character[] |
Font
Legacy. Null unless the Tesseract 3 Engine Mode "TesseractMode" is used.
Declaration
public OcrResult.OcrFont Font { get; }Property Value
| Type | Description |
|---|---|
| OcrResult.OcrFont |
WordNumber
1 based number to identify this word within the OcrResult
Declaration
public int WordNumber { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |