Kofax DOKuStar Validation - Manual (Page 41)

DOKuStar Validation for Ascent Capture Page • 37
Schema
The Schema object describes the batch structure, i.e. the Document Types and Field Types . The schema
has completely been filled with the Ascent Capture form types and index fields for this batch upon opening, so you
don’t have to care about filling this structure.
Note: Although technically adding DocumentType s and FieldType s on the fly is possible, the corresponding
data would not be transferred back to Ascent Capture.
The Schema and belonging descendents will be used when defining events, e.g. wanting a ... Changed event for
FieldType TotalAmount on DocumentType Invoice , wanting an event for every text field, etc. You
will hardly use them within the event handling code.
Properties of the Schema object (excerpt):
Property Returns Description
DocumentTypes DocumentTypes Returns a collection of DocumentType objects
FieldClasses FieldClasses Returns a collection of FieldClass objects
DocumentTypes
DocumentTypes is a collection object that holds a list of DocumentType objects. There are methods and
properties to traverse through the list and access individual elements in the collection. Also, as with every collection,
For ... Each can be used to traverse through the list.
An individual element can be accessed by using the At property. This property can take a DocumentType object
as a parameter or a string that denotes the DocumentType . The At property is the default property and so can be
omitted. If, for example, MyDocType is a Document object that has the name MyInvoice , the following four
statements will all deliver the same result:
DocumentTypes.At(MyDocType)
DocumentTypes(MyDocType)
DocumentTypes.At(„MyInvoice“)
DocumentTypes(„MyInvoice“)
Properties and methods of the DocumentTypes object (excerpt):