|
Octobox API
4.1.0
Octobox Scripting API
|
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... | |
Object containing the extraction results.
|
inline |
Create a new extraction result object.
|
inline |
Add a new alternative to the alternatives collection.
| alternative | Alternative to add |
|
inline |
Remove all existing alternatives and add a new empty alternative.
| addDummy | True to add a new empty alternative after clearing |
|
inline |
Insert a new alternative to the alternatives collection at the specified index.
| alternative | Alternative to add |
| index | Index where to insert |
|
inline |
Remove the alternative at the specified index (if no alternatives remain, an empty alternative will be added).
| index | Index of the alternative to remove |
|
inline |
Set the first alternative for this field (an error is thrown if the field contains multiple alternatives and resetAlternatives is not set).
| alternative | New alternative |
| resetAlternatives | Optionally remove all existing alternatives and add value to a new alternative. Default: False |
| clearZones | Optionally remove all zone information. Default: False |
| isModified | Optionally set field as modified. This will require the field to be validated again. Default: False |
| isValid | Optionally set field as valid. Default: True |
|
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).
| value | New field value |
| resetAlternatives | Optionally remove all existing alternatives and add value to a new alternative. Default: False |
| clearZones | Optionally remove all zone information. Default: False |
| isModified | Optionally set field as modified. This will require the field to be validated again. Default: False |
| isValid | Optionally set field as valid. Default: True |
| displayValue | Optional display value (combobox only) |
|
get |
Collection of alternatives linked to this result.
|
get |
Indicate that this field contains a valid value related to the data type of the field.
|
get |
Concatenated value of this fields alternatives display values or values if no display values exist (used in combobox only).
|
get |
Concatenated error descriptions of this fields alternatives.
|
get |
Get the extraction field defined in the Extraction activity.
|
get |
Indicates if this field encountered an error in the Extraction activity.
|
get |
Indicates if this field is always valid (defined in Validation activity).
|
getset |
Indicates if this field can be used to assign to in validation during zone selection
|
getset |
Indicates if this field was manually confirmed by a user in the validation module or this field doesn't require confirmation.
|
getset |
Indicates if this field requires a value.
|
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
|
get |
Indicates if this field requires a value.
|
get |
Indicates if this field is forced by a user in the validation module.
|
getset |
Indicates if a field was modified in the validation module and not yet validated.
|
get |
Indicates if this field is valid.
|
getset |
Min confidence determining if a zone in zone selection mode in Validation is semi valid or invalid
|
getset |
Min confidence determining if a zone in zone selection mode in Validation is valid or semi valid
|
get |
Concatenated value of this fields alternatives values.
1.8.13