Octobox API  4.1.0
Octobox Scripting API
Public Member Functions | Properties
SCOcrWord

Object containing a recognized word in the block. More...

Public Member Functions

void AddChar (SCOcrChar c)
 Add a new char to the word. More...
 
void InsertChar (int index, SCOcrChar c)
 Insert a char at a specific index. More...
 
void RemoveChar (int index)
 Remove a char at a specific index. More...
 
 SCOcrWord ()
 Default constructor. More...
 

Properties

int BlockIndex [get, set]
 Index of the word in the block. More...
 
IReadOnlyCollection< SCOcrChar > Chars [get]
 Collection of characters of the word. More...
 
float Confidence [get, set]
 OCR confidence of the word. More...
 
SCOcrChar FirstUnconfidentChar [get]
 First unconfident character in the word. More...
 
double Height [get, set]
 Height of the word. More...
 
double Left [get, set]
 Left position of the word. More...
 
int Orientation [get, set]
 Orientation of the word. More...
 
int PageIndex [get, set]
 Index of the page containing the word. More...
 
string Text [get, set]
 Text of the word. More...
 
double Top [get, set]
 Top psition of the word. More...
 
string Type [get]
 Type of word. More...
 
double Width [get, set]
 With of the word. More...
 

Detailed Description

Object containing a recognized word in the block.

Constructor & Destructor Documentation

◆ SCOcrWord()

SCOcrWord ( )
inline

Default constructor.

Member Function Documentation

◆ AddChar()

void AddChar ( SCOcrChar  c)
inline

Add a new char to the word.

Parameters
cChar to add

◆ InsertChar()

void InsertChar ( int  index,
SCOcrChar  c 
)
inline

Insert a char at a specific index.

Parameters
indexIndex in the line to insert the word
cchar to insert

◆ RemoveChar()

void RemoveChar ( int  index)
inline

Remove a char at a specific index.

Parameters
indexIndex in the word of the char to remove

Property Documentation

◆ BlockIndex

int BlockIndex
getset

Index of the word in the block.

◆ Chars

IReadOnlyCollection<SCOcrChar> Chars
get

Collection of characters of the word.

◆ Confidence

float Confidence
getset

OCR confidence of the word.

◆ FirstUnconfidentChar

SCOcrChar FirstUnconfidentChar
get

First unconfident character in the word.

◆ Height

double Height
getset

Height of the word.

◆ Left

double Left
getset

Left position of the word.

◆ Orientation

int Orientation
getset

Orientation of the word.

◆ PageIndex

int PageIndex
getset

Index of the page containing the word.

◆ Text

string Text
getset

Text of the word.

◆ Top

double Top
getset

Top psition of the word.

◆ Type

string Type
get

Type of word.

◆ Width

double Width
getset

With of the word.