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

Object containing OCR line settings. More...

Public Member Functions

void AddWord (SCOcrWord word)
 Add a new word to the line. More...
 
void InsertWord (int index, SCOcrWord word)
 Insert a word at a specific index. More...
 
void RemoveWord (int index)
 Remove a word at a specific index. More...
 
 SCZone ()
 Default constructor. More...
 

Properties

double Bottom [get]
 Bottom position of the line. More...
 
SCOcrChar FirstUnconfidentChar [get]
 First unconfident character of the line. More...
 
double Height [get]
 Height of the line. More...
 
double Left [get]
 Left position of the line. More...
 
int PageIndex [get]
 Index of the page containing the line. More...
 
double Right [get]
 Right position of the line. More...
 
string Text [get]
 Text of the line. More...
 
double Top [get]
 Top position of the line. More...
 
double Width [get]
 Width of the line. More...
 
IReadOnlyCollection< SCOcrWord > Words [get]
 Collection of words contained on the line. More...
 

Detailed Description

Object containing OCR line settings.

Constructor & Destructor Documentation

◆ SCZone()

SCZone ( )
inline

Default constructor.

Member Function Documentation

◆ AddWord()

void AddWord ( SCOcrWord  word)
inline

Add a new word to the line.

Parameters
wordWord to add

◆ InsertWord()

void InsertWord ( int  index,
SCOcrWord  word 
)
inline

Insert a word at a specific index.

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

◆ RemoveWord()

void RemoveWord ( int  index)
inline

Remove a word at a specific index.

Parameters
indexIndex in the line of the word to remove

Property Documentation

◆ Bottom

double Bottom
get

Bottom position of the line.

◆ FirstUnconfidentChar

SCOcrChar FirstUnconfidentChar
get

First unconfident character of the line.

◆ Height

double Height
get

Height of the line.

◆ Left

double Left
get

Left position of the line.

◆ PageIndex

int PageIndex
get

Index of the page containing the line.

◆ Right

double Right
get

Right position of the line.

◆ Text

string Text
get

Text of the line.

◆ Top

double Top
get

Top position of the line.

◆ Width

double Width
get

Width of the line.

◆ Words

IReadOnlyCollection<SCOcrWord> Words
get

Collection of words contained on the line.