|
Octobox API
4.1.0
Octobox Scripting API
|
Object containing the alternatives. More...
Public Member Functions | |
| SCAlternativeSubField | GetSubFieldByName (string name) |
| Get the extraction field object based on the passed through extraction field name. More... | |
| SCAlternative () | |
| Create a new Alternative object. More... | |
| SCAlternative (object alt) | |
| Internal constructor for object initialization used by OCTOBOX (Do not use). More... | |
Properties | |
| double | Confidence [get, set] |
| Confidence in % for this alternative. More... | |
| string | DescriptionValue [get, set] |
| Optional description value of this alternative. More... | |
| string | DisplayValue [get, set] |
| Optional display value of this alternative (combobox only). More... | |
| string | ErrDescription [get, set] |
| Error description to show when the alternative is not valid. More... | |
| string | FileName [get] |
| File name of the medium this alternative belongs to. More... | |
| string | FileNameFull [get] |
| Full filename this alternative belongs to. More... | |
| bool | IsValidationAlwaysValid [get] |
| Indicates if this alternative is always valid (defined in Validation Activity). More... | |
| bool | IsValidationConfirmed [get, set] |
| Indicates if this alternative is manually confirmed by a user in the validation module. More... | |
| bool | IsValidationFieldRequired [get] |
| Indicates if this alternative must contain a value (defined in Validation Activity) More... | |
| bool | IsValidationForced [get] |
| Indicates if this alternative is forced in the validation module. More... | |
| bool | IsValidationModified [get, set] |
| Indicates if this alternative is modified in the validation module and not yet validated. More... | |
| bool | IsValidationRuleValid [get, set] |
| Indicates if this alternative was processed by a validationrule (Null if not) and the result. Must be set when using a scriptvalidation rule as locator alternatives filter More... | |
| bool | IsValidationValid [get] |
| Indicates if this alternative is valid. More... | |
| bool | IsValidationZoneInvalid [get, set] |
| Indicates if this alternative has a invalid zone (zone selection only) More... | |
| int | MediaIndex [get] |
| Index of the medium in the document this alternative belongs to. More... | |
| int | OffsetX [get, set] |
| Registration field offset in pixels on the X axis. More... | |
| int | OffsetY [get, set] |
| Registration field offset in pixels on the Y axis. More... | |
| double | OmrFillPerc [get] |
| OMR fill percentage if this is an OMR result alternative. More... | |
| int | PageIndex [get] |
| Index of the page in the medium this alternative belongs to. More... | |
| Guid | RecordDatabaseId [get] |
| ID of the database this alternative is extracted from. More... | |
| string | RecordIndex [get] |
| Database record index for alternatives validated by lookup validation rule. More... | |
| List< SCAlternativeSubField > | SubFields [get, set] |
| Collection of alternative sub fields. More... | |
| string | Value [get, set] |
| Text value of this alternative. More... | |
| SCZone | Zone [get, set] |
| Recognition result containing region and value of this alternative. More... | |
Object containing the alternatives.
|
inline |
Create a new Alternative object.
|
inline |
Internal constructor for object initialization used by OCTOBOX (Do not use).
| alt | Current alternative |
|
inline |
Get the extraction field object based on the passed through extraction field name.
| name | The extraction field for which to find the extraction results |
|
getset |
Confidence in % for this alternative.
|
getset |
Optional description value of this alternative.
|
getset |
Optional display value of this alternative (combobox only).
|
getset |
Error description to show when the alternative is not valid.
|
get |
File name of the medium this alternative belongs to.
|
get |
Full filename this alternative belongs to.
|
get |
Indicates if this alternative is always valid (defined in Validation Activity).
|
getset |
Indicates if this alternative is manually confirmed by a user in the validation module.
|
get |
Indicates if this alternative must contain a value (defined in Validation Activity)
|
get |
Indicates if this alternative is forced in the validation module.
|
getset |
Indicates if this alternative is modified in the validation module and not yet validated.
|
getset |
Indicates if this alternative was processed by a validationrule (Null if not) and the result. Must be set when using a scriptvalidation rule as locator alternatives filter
|
get |
Indicates if this alternative is valid.
|
getset |
Indicates if this alternative has a invalid zone (zone selection only)
|
get |
Index of the medium in the document this alternative belongs to.
|
getset |
Registration field offset in pixels on the X axis.
|
getset |
Registration field offset in pixels on the Y axis.
|
get |
OMR fill percentage if this is an OMR result alternative.
|
get |
Index of the page in the medium this alternative belongs to.
|
get |
ID of the database this alternative is extracted from.
|
get |
Database record index for alternatives validated by lookup validation rule.
|
getset |
Collection of alternative sub fields.
|
getset |
Text value of this alternative.
|
getset |
Recognition result containing region and value of this alternative.
1.8.13