Class OcrResult.OcrResultTextElement

An abstract class representing discovered OCR DOM text elements such as OcrResult.Character, OcrResult.Word, OcrResult.Line, OcrResult.Paragraph ...

Inheritance
System.Object
OcrResult.OcrResultElement
OcrResult.OcrResultTextElement
OcrResult.Block
OcrResult.Character
OcrResult.Line
OcrResult.Page
OcrResult.Paragraph
OcrResult.Table
OcrResult.Word
Implements
IronSoftware.IDocumentTextObject
IronSoftware.IBoundedDocumentObject
IronSoftware.IDocumentObject
IronSoftware.IBounded
IronSoftware.IColored
IronSoftware.ITransformable
System.ICloneable
Inherited Members
Namespace: IronOcr
Assembly: IronOcr.dll
Syntax
public abstract class OcrResultTextElement : OcrResult.OcrResultElement, IDocumentTextObject, IBoundedDocumentObject, IDocumentObject, IBounded, IColored, ITransformable, ICloneable

Constructors

OcrResultTextElement()

Declaration
protected OcrResultTextElement()

Properties

Bottom

Declaration
public double Bottom { get; set; }
Property Value
Type Description
System.Double

BoundingBox

Declaration
public RectangleF BoundingBox { get; set; }
Property Value
Type Description
System.Drawing.RectangleF

Color

Declaration
public Color Color { get; set; }
Property Value
Type Description
System.Drawing.Color

Confidence

OCR statistical accuracy confidence as an average of every character within this object.

1 = 100%, 0 = 0%

Declaration
public virtual double Confidence { get; }
Property Value
Type Description
System.Double

Contents

Declaration
public string Contents { get; set; }
Property Value
Type Description
System.String

DocumentId

TODO: Implement DocumentId

Declaration
public IDocumentId DocumentId { get; set; }
Property Value
Type Description
IronSoftware.IDocumentId

FillColor

TODO: Implement FillColor

Declaration
public Color FillColor { get; set; }
Property Value
Type Description
System.Drawing.Color

Font

TODO: Implement Font

Declaration
public IDocumentFontObject Font { get; }
Property Value
Type Description
IronSoftware.IDocumentFontObject

FontSize

TODO: Implement FontSize

Declaration
public float FontSize { get; set; }
Property Value
Type Description
System.Single

Left

Declaration
public double Left { get; set; }
Property Value
Type Description
System.Double

Matrix

Declaration
public MatrixStruct Matrix { get; }
Property Value
Type Description
IronSoftware.MatrixStruct

ObjNum

Declaration
public uint ObjNum { get; set; }
Property Value
Type Description
System.UInt32

PageIndex

Declaration
public uint PageIndex { get; set; }
Property Value
Type Description
System.UInt32

PdfDocumentId

Declaration
public IDocumentId PdfDocumentId { get; set; }
Property Value
Type Description
IronSoftware.IDocumentId

RenderMode

TODO: Implement RenderMode

Declaration
public TextRenderModes RenderMode { get; set; }
Property Value
Type Description
IronSoftware.TextRenderModes

Right

Declaration
public double Right { get; set; }
Property Value
Type Description
System.Double

Scale

Declaration
public PointF Scale { get; set; }
Property Value
Type Description
System.Drawing.PointF

StrokeColor

TODO: Implement StrokeColor

Declaration
public Color StrokeColor { get; set; }
Property Value
Type Description
System.Drawing.Color

Text

The full text of this OcrResultElement as a string. This is truncated when the product is unlicensed.

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

TextDirection

The direction text was read in: such as 'Left to Right' or 'Top to Bottom'.

Declaration
public OcrResult.TextFlow TextDirection { get; }
Property Value
Type Description
OcrResult.TextFlow

Top

Declaration
public double Top { get; set; }
Property Value
Type Description
System.Double

Translate

Declaration
public PointF Translate { get; set; }
Property Value
Type Description
System.Drawing.PointF

Methods

Clone()

Declaration
public object Clone()
Returns
Type Description
System.Object

ToString()

Full OCR text discovered within this object.

A synonym of Text

.

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

IronSoftware.IDocumentTextObject
IronSoftware.IBoundedDocumentObject
IronSoftware.IDocumentObject
IronSoftware.IBounded
IronSoftware.IColored
IronSoftware.ITransformable
System.ICloneable

Inherited members

ToBitmap(OcrInput)
Width
Height
X
Y
Location