Kofax DOKuStar Validation - Manual (Page 66)

DOKuStar Validation Programming Manual Page • 62
Controller
The Controller object is the third sub-object of the Dataset , with the purpose of controlling the behavior of the
application.
Using the controller object enables to
- activate and deactivate documents and fields,
- administer the cursor.
The Cursor object is described below in a separate chapter.
With the controller object, a second way of activating fields or documents (the first one is the Activate method on
the field and document object) is provided. You can determine which field/document is active or activate/deactivate
a field/document.
Properties and methods of the Controller object (excerpt):
Property/Method Returns Description
ActivateDocument Boolean Activates a specific document. Returns False if the document could
not be activated (e.g., a scripting routine canceled the activation)
Parameter:
Doc As Document
ActivateField Boolean Activates a specific field. Returns False if the field could not be
activated (e.g., a scripting routine canceled the activation)
Parameter:
fld As Field
ActiveDocument Document Returns the currently active document
ActiveField Field Returns the currently active field
Cursor Cursor Gets/Sets the currently active cursor
Cursors Cursors Gets the collection of currently defined cursors
DeactivateDocument Boolean Deactivates the current document. Returns False if the document
could not be deactivated (e.g., a scripting routine canceled the
deactivation)
DeactivateField Boolean Deactivates the current field. Returns False if the field could not be
deactivated (e.g., a scripting routine canceled the deactivation)
HasCursor Boolean Returns True if there the controller has a cursor assigned