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

Object with the medium settings. More...

Public Member Functions

void ClearRecognitionResults ()
 Removes all recognition results from this medium More...
 
void ClearValidationImages ()
 Remove previously generated validation export images, so they may be regenerated at a later step. More...
 
void ConfirmAllPages ()
 Marks all pages as confirmed for zone selection validation More...
 
void RemoveRecognitionResult (int index)
 Removes the recognition result at the specified index More...
 
void RemoveRecognitionZones (List< SCZone > zonesToRemove)
 Removes all recognition results from the removed zone. More...
 
 SCMedium ()
 Internal constructor for object initialization used by OCTOBOX (Do not use). More...
 

Properties

string FileName [get]
 Filename of the external file. More...
 
bool IsForceHighQualityValidationImages [get, set]
 IsForceHighQualityValidationImages property is set for media where the advanced recognition engine should export the validation export images should be generated at the highest quality regardless the specified setting. More...
 
bool IsForceStandardTextExtraction [get, set]
 IsForceStandardTextExtraction property is set for media where the advanced recognition engine should not attempt to extract existing text and the standard text extraction should be used instead. More...
 
bool IsGenerated [get, set]
 IsGenerated property is set for media with a pdf file generated from an MSOffice document by the standard conversion or a generated email body. When set Advanced recognition will only use the existing text and not perform a new recognition. If Advanced Pdf generation is enabled a medium with this option set, will not be regenerated and the already generated pdf file will be returned. More...
 
bool IsPreventPdfGeneration [get, set]
 IsPreventPdfGeneration property corresponds to the same property in the Advanced Pdf generation profile. When true, this medium will not have a pdf generated regardless of the value of this property in the Advanced pdf generation profile. When false, Pdf generation will be determined by the property in the profile. More...
 
IReadOnlyCollection< SCOcrResult > OcrResults [get]
 Collection of ocr results. More...
 
int PageCount [get, set]
 Pagecount of this medium. More...
 
List< int > RemovedPages [get]
 Collection of the number of the removed pages. More...
 
List< string > ValidationFileNames [get]
 Validation image file names More...
 
IReadOnlyCollection< SCValidationPage > ValidationPages [get]
 A list of all validation pages in this medium More...
 

Detailed Description

Object with the medium settings.

Constructor & Destructor Documentation

◆ SCMedium()

SCMedium ( )
inline

Internal constructor for object initialization used by OCTOBOX (Do not use).

Member Function Documentation

◆ ClearRecognitionResults()

void ClearRecognitionResults ( )
inline

Removes all recognition results from this medium

◆ ClearValidationImages()

void ClearValidationImages ( )
inline

Remove previously generated validation export images, so they may be regenerated at a later step.

◆ ConfirmAllPages()

void ConfirmAllPages ( )
inline

Marks all pages as confirmed for zone selection validation

◆ RemoveRecognitionResult()

void RemoveRecognitionResult ( int  index)
inline

Removes the recognition result at the specified index

◆ RemoveRecognitionZones()

void RemoveRecognitionZones ( List< SCZone >  zonesToRemove)
inline

Removes all recognition results from the removed zone.

Parameters
zonesToRemoveDocument to remove pages from. A single medium is required.
Returns
List of actual removed zero based page indices

Property Documentation

◆ FileName

string FileName
get

Filename of the external file.

◆ IsForceHighQualityValidationImages

bool IsForceHighQualityValidationImages
getset

IsForceHighQualityValidationImages property is set for media where the advanced recognition engine should export the validation export images should be generated at the highest quality regardless the specified setting.

◆ IsForceStandardTextExtraction

bool IsForceStandardTextExtraction
getset

IsForceStandardTextExtraction property is set for media where the advanced recognition engine should not attempt to extract existing text and the standard text extraction should be used instead.

◆ IsGenerated

bool IsGenerated
getset

IsGenerated property is set for media with a pdf file generated from an MSOffice document by the standard conversion or a generated email body. When set Advanced recognition will only use the existing text and not perform a new recognition. If Advanced Pdf generation is enabled a medium with this option set, will not be regenerated and the already generated pdf file will be returned.

◆ IsPreventPdfGeneration

bool IsPreventPdfGeneration
getset

IsPreventPdfGeneration property corresponds to the same property in the Advanced Pdf generation profile. When true, this medium will not have a pdf generated regardless of the value of this property in the Advanced pdf generation profile. When false, Pdf generation will be determined by the property in the profile.

◆ OcrResults

IReadOnlyCollection<SCOcrResult> OcrResults
get

Collection of ocr results.

◆ PageCount

int PageCount
getset

Pagecount of this medium.

◆ RemovedPages

List<int> RemovedPages
get

Collection of the number of the removed pages.

◆ ValidationFileNames

List<string> ValidationFileNames
get

Validation image file names

◆ ValidationPages

IReadOnlyCollection<SCValidationPage> ValidationPages
get

A list of all validation pages in this medium