Kofax DOKuStar Validation - Manual (Page 61)

DOKuStar Validation Programming Manual Page • 57
Field
Properties and methods of the Field object (excerpt):
Property/Method Returns Description
Activate Boolean Activates the field. Returns True if successful.
Activated Boolean Returns True if the field is currently activated.
ActivateSubField Boolean Activates a sub-field. Returns True if successful. Can be used to
jump to a specific cell of a table field.
Parameter:
SubField As Field
ActiveSubField Field Returns the currently active subfield (i.e. table cell) of a field.
Alternatives Alternatives Returns the list of alternatives for this field. This assumes that
DOKuStar is used as the recognition engine and parameterized to
deliver alternatives.
Composed Boolean Returns True if the field is a composed field, i.e. has sub-fields.
Deactivate Boolean Deactivates the field, moving activation to the next one.
DeactivateSubField Boolean Deactivates the current sub-field, moving activation to the next one.
HasSourceInfo Boolean Returns True if the field has a SourceInfo object assigned.
Name String Name of the field. This is the FieldType name, which in turn is the
index field name from Ascent Capture
SourceInfo ImageSourceInfo Returns the ImageSourceInfo object assigned to this field.
Contains the box of the field.
State State Returns the state of the field.
States are:
StateEmpty
StateError
StateNone
StateReject
StateOk
Value String Value of the field. Always a string.