User guide

DOKuStar Validation Programming Manual Page • 51
Schema
The Schema object describes the batch structure, i.e. the Document Types and Field Types.
The
Schema and belonging descendents will be used when defining events, e.g. if you want a ...Changed event
for
FieldType TotalAmount on DocumentType Invoice, if you want 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):
Property/Method Returns Description
At DocumentType Delivers a document type object at the specified position
Begin DocumentType Delivers the first document type object in the collection
Empty Boolean Returns true if the collection is empty
Last DocumentType Delivers the last document type object in the collection
Next DocumentType Delivers the next document type in the list
Parameter:
PreviousDocumentType As DocumentType
Previous DocumentType Delivers the previous document type in the list
Parameter:
NextDocumentType As DocumentType