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

Object containing the extraction results. More...

Public Member Functions

void AddAlternative (SCAlternative alternative)
 Add a new alternative to the alternatives collection. More...
 
void ClearAlternatives (bool addDummy=true)
 Remove all existing alternatives and add a new empty alternative. More...
 
void InsertAlternative (SCAlternative alternative, int index)
 Insert a new alternative to the alternatives collection at the specified index. More...
 
void RemoveAlternative (int index)
 Remove the alternative at the specified index (if no alternatives remain, an empty alternative will be added). More...
 
 SCExtractionResult ()
 Create a new extraction result object. More...
 
void SetAlternative (SCAlternative alternative, bool resetAlternatives=false, bool clearZones=false, bool isModified=false, bool isValid=true)
 Set the first alternative for this field (an error is thrown if the field contains multiple alternatives and resetAlternatives is not set). More...
 
void SetValue (string value, bool resetAlternatives=false, bool clearZones=false, bool isModified=false, bool isValid=true, string displayValue="")
 Set the value of the first alternative for this field (an error is thrown if the field contains multiple alternatives and resetAlternatives is not set). More...
 

Properties

IReadOnlyCollection< SCAlternative > Alternatives [get]
 Collection of alternatives linked to this result. More...
 
bool BoolValue [get]
 Indicate that this field contains a valid value related to the data type of the field. More...
 
string DisplayValue [get]
 Concatenated value of this fields alternatives display values or values if no display values exist (used in combobox only). More...
 
string ErrDescription [get]
 Concatenated error descriptions of this fields alternatives. More...
 
SCExtractionField ExtractionField [get]
 Get the extraction field defined in the Extraction activity. More...
 
bool IsExtractionError [get]
 Indicates if this field encountered an error in the Extraction activity. More...
 
bool IsValidationAlwaysValid [get]
 Indicates if this field is always valid (defined in Validation activity). More...
 
bool IsValidationAssignable [get, set]
 Indicates if this field can be used to assign to in validation during zone selection More...
 
bool IsValidationConfirmed [get, set]
 Indicates if this field was manually confirmed by a user in the validation module or this field doesn't require confirmation. More...
 
bool IsValidationFieldIgnored [get, set]
 Indicates if this field requires a value. More...
 
bool IsValidationFieldRefreshRequired [get, set]
 When set on any field in the document, the validation screen will refresh all fields and move to the first invalid one. Setting this value on a combobox field will also trigger the fields BeforeDropdown event enabling refresh of the combobox collection More...
 
bool IsValidationFieldRequired [get]
 Indicates if this field requires a value. More...
 
bool IsValidationForced [get]
 Indicates if this field is forced by a user in the validation module. More...
 
bool IsValidationModified [get, set]
 Indicates if a field was modified in the validation module and not yet validated. More...
 
bool IsValidationValid [get]
 Indicates if this field is valid. More...
 
int ValidationMinConfidenceLower [get, set]
 Min confidence determining if a zone in zone selection mode in Validation is semi valid or invalid More...
 
int ValidationMinConfidenceUpper [get, set]
 Min confidence determining if a zone in zone selection mode in Validation is valid or semi valid More...
 
string Value [get]
 Concatenated value of this fields alternatives values. More...
 

Detailed Description

Object containing the extraction results.

Constructor & Destructor Documentation

◆ SCExtractionResult()

SCExtractionResult ( )
inline

Create a new extraction result object.

Member Function Documentation

◆ AddAlternative()

void AddAlternative ( SCAlternative  alternative)
inline

Add a new alternative to the alternatives collection.

Parameters
alternativeAlternative to add

◆ ClearAlternatives()

void ClearAlternatives ( bool  addDummy = true)
inline

Remove all existing alternatives and add a new empty alternative.

Parameters
addDummyTrue to add a new empty alternative after clearing

◆ InsertAlternative()

void InsertAlternative ( SCAlternative  alternative,
int  index 
)
inline

Insert a new alternative to the alternatives collection at the specified index.

Parameters
alternativeAlternative to add
indexIndex where to insert

◆ RemoveAlternative()

void RemoveAlternative ( int  index)
inline

Remove the alternative at the specified index (if no alternatives remain, an empty alternative will be added).

Parameters
indexIndex of the alternative to remove

◆ SetAlternative()

void SetAlternative ( SCAlternative  alternative,
bool  resetAlternatives = false,
bool  clearZones = false,
bool  isModified = false,
bool  isValid = true 
)
inline

Set the first alternative for this field (an error is thrown if the field contains multiple alternatives and resetAlternatives is not set).

Parameters
alternativeNew alternative
resetAlternativesOptionally remove all existing alternatives and add value to a new alternative. Default: False
clearZonesOptionally remove all zone information. Default: False
isModifiedOptionally set field as modified. This will require the field to be validated again. Default: False
isValidOptionally set field as valid. Default: True

◆ SetValue()

void SetValue ( string  value,
bool  resetAlternatives = false,
bool  clearZones = false,
bool  isModified = false,
bool  isValid = true,
string  displayValue = "" 
)
inline

Set the value of the first alternative for this field (an error is thrown if the field contains multiple alternatives and resetAlternatives is not set).

Parameters
valueNew field value
resetAlternativesOptionally remove all existing alternatives and add value to a new alternative. Default: False
clearZonesOptionally remove all zone information. Default: False
isModifiedOptionally set field as modified. This will require the field to be validated again. Default: False
isValidOptionally set field as valid. Default: True
displayValueOptional display value (combobox only)

Property Documentation

◆ Alternatives

IReadOnlyCollection<SCAlternative> Alternatives
get

Collection of alternatives linked to this result.

◆ BoolValue

bool BoolValue
get

Indicate that this field contains a valid value related to the data type of the field.

◆ DisplayValue

string DisplayValue
get

Concatenated value of this fields alternatives display values or values if no display values exist (used in combobox only).

◆ ErrDescription

string ErrDescription
get

Concatenated error descriptions of this fields alternatives.

◆ ExtractionField

SCExtractionField ExtractionField
get

Get the extraction field defined in the Extraction activity.

◆ IsExtractionError

bool IsExtractionError
get

Indicates if this field encountered an error in the Extraction activity.

◆ IsValidationAlwaysValid

bool IsValidationAlwaysValid
get

Indicates if this field is always valid (defined in Validation activity).

◆ IsValidationAssignable

bool IsValidationAssignable
getset

Indicates if this field can be used to assign to in validation during zone selection

◆ IsValidationConfirmed

bool IsValidationConfirmed
getset

Indicates if this field was manually confirmed by a user in the validation module or this field doesn't require confirmation.

◆ IsValidationFieldIgnored

bool IsValidationFieldIgnored
getset

Indicates if this field requires a value.

◆ IsValidationFieldRefreshRequired

bool IsValidationFieldRefreshRequired
getset

When set on any field in the document, the validation screen will refresh all fields and move to the first invalid one. Setting this value on a combobox field will also trigger the fields BeforeDropdown event enabling refresh of the combobox collection

◆ IsValidationFieldRequired

bool IsValidationFieldRequired
get

Indicates if this field requires a value.

◆ IsValidationForced

bool IsValidationForced
get

Indicates if this field is forced by a user in the validation module.

◆ IsValidationModified

bool IsValidationModified
getset

Indicates if a field was modified in the validation module and not yet validated.

◆ IsValidationValid

bool IsValidationValid
get

Indicates if this field is valid.

◆ ValidationMinConfidenceLower

int ValidationMinConfidenceLower
getset

Min confidence determining if a zone in zone selection mode in Validation is semi valid or invalid

◆ ValidationMinConfidenceUpper

int ValidationMinConfidenceUpper
getset

Min confidence determining if a zone in zone selection mode in Validation is valid or semi valid

◆ Value

string Value
get

Concatenated value of this fields alternatives values.